diff --git a/docs/en/about-appium/api.md b/docs/en/about-appium/api.md
index 42c893124..3dddcfe7a 100644
--- a/docs/en/about-appium/api.md
+++ b/docs/en/about-appium/api.md
@@ -3,8 +3,9 @@
## Appium API Documentation
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/README.md b/docs/en/commands/README.md
index 42c893124..3dddcfe7a 100644
--- a/docs/en/commands/README.md
+++ b/docs/en/commands/README.md
@@ -3,8 +3,9 @@
## Appium API Documentation
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/context/README.md b/docs/en/commands/context/README.md
index 0cd46f5e5..a6fda4447 100644
--- a/docs/en/commands/context/README.md
+++ b/docs/en/commands/context/README.md
@@ -3,12 +3,15 @@
## Appium API Documentation
### /docs/en/commands/context
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/context/get-context.md b/docs/en/commands/context/get-context.md
index e101efde2..d8a601417 100644
--- a/docs/en/commands/context/get-context.md
+++ b/docs/en/commands/context/get-context.md
@@ -1,16 +1,20 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
# Get Current Context
Get the current context in which Appium is running
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
```java
// Java
String context = driver.getContext();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
```python
# Python
context = driver.current_context
@@ -19,6 +23,7 @@ context = driver.context
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
```javascript
// Javascript
// webdriver.io example
@@ -26,27 +31,32 @@ let context = driver.context();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
// wd example
let context = await driver.currentContext();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
```ruby
# Ruby
# ruby_lib example
context = current_context
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
# ruby_lib_core example
context = @driver.current_context
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
```php
# PHP
$context = $driver->context();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
```csharp
// C#
// TODO C# sample
@@ -54,6 +64,7 @@ $context = $driver->context();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
## Description
Retrieve the current context. This can be either `NATIVE_APP` for the native context, or a web view context, which will be:
@@ -66,8 +77,10 @@ For information on contexts, see Appium's [hybrid automation docs](/docs/en/writ
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -80,6 +93,7 @@ For information on contexts, see Appium's [hybrid automation docs](/docs/en/writ
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -94,23 +108,28 @@ For information on contexts, see Appium's [hybrid automation docs](/docs/en/writ
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
`GET /wd/hub/session/:session_id/context`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
The name of the current context (`String`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)
* [JSONWP Specification](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts)
diff --git a/docs/en/commands/context/get-contexts.md b/docs/en/commands/context/get-contexts.md
index e2351aa2c..45e4a0e00 100644
--- a/docs/en/commands/context/get-contexts.md
+++ b/docs/en/commands/context/get-contexts.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
# Get All Contexts
Get all the contexts available to automate
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
```java
// Java
Set contextNames = driver.getContextHandles();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
```python
# Python
contexts = driver.contexts
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ let contexts = driver.contexts();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
// wd example
let contexts = await driver.contexts();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
```ruby
# Ruby
# ruby_lib example
context = available_contexts
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
# ruby_lib_core example
context = @driver.available_contexts
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
```php
# PHP
$contexts = $driver->contexts();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
```csharp
// C#
// TODO C# sample
@@ -53,6 +63,7 @@ $contexts = $driver->contexts();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
## Description
Retrieve all the contexts available to be automated. This will include, at least, the native context. There can also be zero or more web view contexts. For information on the format of the context names, see the [get context documentation](/docs/en/commands/context/get-context.md).
@@ -61,8 +72,10 @@ For information on contexts, see Appium's [hybrid automation docs](/docs/en/writ
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -75,6 +88,7 @@ For information on contexts, see Appium's [hybrid automation docs](/docs/en/writ
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -89,23 +103,28 @@ For information on contexts, see Appium's [hybrid automation docs](/docs/en/writ
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
`GET /wd/hub/session/:session_id/contexts`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
Array of the names of all available contexts (`Array`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-contexts.yml)
* [JSONWP Specification](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts)
diff --git a/docs/en/commands/context/set-context.md b/docs/en/commands/context/set-context.md
index b2b935866..ed0f3ea40 100644
--- a/docs/en/commands/context/set-context.md
+++ b/docs/en/commands/context/set-context.md
@@ -1,10 +1,13 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
# Set Current Context
Set the context being automated
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
```java
// Java
Set contextNames = driver.getContextHandles();
@@ -14,6 +17,7 @@ driver.context("NATIVE_APP");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
```python
# Python
webview = driver.contexts[1]
@@ -23,6 +27,7 @@ driver.switch_to.context('NATIVE_APP')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
```javascript
// Javascript
// webdriver.io example
@@ -33,6 +38,7 @@ driver.context('NATIVE_APP');
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
// wd example
let contexts = await driver.contexts();
await driver.context(contexts[1]);
@@ -41,6 +47,7 @@ await driver.context('NATIVE_APP');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
```ruby
# Ruby
# ruby_lib example
@@ -50,6 +57,7 @@ set_context(webview)
set_context('NATIVE_APP')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
# ruby_lib_core example
webview = @driver.available_contexts[1]
@driver.set_context(webview)
@@ -58,6 +66,7 @@ webview = @driver.available_contexts[1]
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
```php
# PHP
$contexts = $driver->contexts();
@@ -67,6 +76,7 @@ $driver->context('NATIVE_APP');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
```csharp
// C#
// TODO C# sample
@@ -74,6 +84,7 @@ $driver->context('NATIVE_APP');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
## Description
Set the current context to that passed in. If this is moving into a web view context it will involve attempting to connect to that web view:
@@ -87,8 +98,10 @@ For information on contexts, see Appium's [hybrid automation docs](/docs/en/writ
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -101,6 +114,7 @@ For information on contexts, see Appium's [hybrid automation docs](/docs/en/writ
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -115,25 +129,30 @@ For information on contexts, see Appium's [hybrid automation docs](/docs/en/writ
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
`POST /wd/hub/session/:session_id/context`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
|name|type|description|
|----|----|-----------|
| name | `String` | The name of the context to which to change |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/set-context.yml)
* [JSONWP Specification](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts)
diff --git a/docs/en/commands/device/README.md b/docs/en/commands/device/README.md
index cab0c23ca..5a1ff7518 100644
--- a/docs/en/commands/device/README.md
+++ b/docs/en/commands/device/README.md
@@ -3,9 +3,11 @@
## Appium API Documentation
### /docs/en/commands/device
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/activity/README.md b/docs/en/commands/device/activity/README.md
index 5a32dc349..fdc17dcb2 100644
--- a/docs/en/commands/device/activity/README.md
+++ b/docs/en/commands/device/activity/README.md
@@ -3,12 +3,15 @@
## Appium API Documentation
### /docs/en/commands/device/activity
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/activity/current-activity.md b/docs/en/commands/device/activity/current-activity.md
index 38104bda8..024da96ee 100644
--- a/docs/en/commands/device/activity/current-activity.md
+++ b/docs/en/commands/device/activity/current-activity.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
# Get Current Activity
Get the name of the current Android activity
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
```java
// Java
String activity = driver.currentActivity();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
```python
# Python
activity = self.driver.current_activity;
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ let activity = driver.currentActivity();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
// wd example
let activity = await driver.getCurrentActivity();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
```ruby
# Ruby
# ruby_lib example
current_activity
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
# ruby_lib_core example
@driver.current_activity
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
```php
# PHP
$activity = $driver->currentActivity();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
```csharp
// C#
// TODO C# sample
@@ -55,8 +65,10 @@ $activity = $driver->currentActivity();
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ $activity = $driver->currentActivity();
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,23 +96,28 @@ $activity = $driver->currentActivity();
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
`GET /wd/hub/session/:session_id/appium/device/current_activity`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
Name of the current [activity](https://developer.android.com/reference/android/app/Activity.html) (`string`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-activity.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L411)
diff --git a/docs/en/commands/device/activity/current-package.md b/docs/en/commands/device/activity/current-package.md
index f9253461f..b57f4b3c1 100644
--- a/docs/en/commands/device/activity/current-package.md
+++ b/docs/en/commands/device/activity/current-package.md
@@ -1,48 +1,58 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
# Get Current Package
Get the name of the current Android package
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
```java
// Java
String package = driver.getCurrentPackage();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
```python
# Python
package = self.driver.current_package;
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
// wd example
let package = await driver.getCurrentPackage();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
```ruby
# Ruby
# ruby_lib example
current_package
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
# ruby_lib_core example
@driver.current_package
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
```csharp
// C#
// TODO C# sample
@@ -52,8 +62,10 @@ current_package
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -66,6 +78,7 @@ current_package
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -80,23 +93,28 @@ current_package
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
`GET /wd/hub/session/:session_id/appium/device/current_package`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
Name of the current [package](https://developer.android.com/reference/java/lang/Package.html) (`string`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/current-package.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L414)
diff --git a/docs/en/commands/device/activity/start-activity.md b/docs/en/commands/device/activity/start-activity.md
index f43e409fd..241745630 100644
--- a/docs/en/commands/device/activity/start-activity.md
+++ b/docs/en/commands/device/activity/start-activity.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
# Start Activity
Start an Android activity by providing package name and activity name
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
```java
// Java
driver.startActivity(new Activity("com.example", "ActivityName"));
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
```python
# Python
self.driver.start_activity("com.example", "ActivityName");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,6 +29,7 @@ driver.startActivity("com.example", "ActivityName");
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
// wd example
await driver.startActivity({
appPackage: "com.example",
@@ -32,17 +38,20 @@ await driver.startActivity({
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
```ruby
# Ruby
# ruby_lib example
start_activity app_package: "com.example", app_activity: "ActivityName"
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
# ruby_lib_core example
@driver.start_activity app_package: "com.example", app_activity: "ActivityName"
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
```php
# PHP
$driver->startActivity(array('appPackage' => 'com.example',
@@ -50,6 +59,7 @@ $driver->startActivity(array('appPackage' => 'com.example',
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
```csharp
// C#
// TODO C# sample
@@ -59,8 +69,10 @@ $driver->startActivity(array('appPackage' => 'com.example',
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -73,6 +85,7 @@ $driver->startActivity(array('appPackage' => 'com.example',
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -87,16 +100,19 @@ $driver->startActivity(array('appPackage' => 'com.example',
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
`POST /wd/hub/session/:session_id/appium/device/start_activity`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
|name|type|description|
|----|----|-----------|
@@ -110,9 +126,11 @@ $driver->startActivity(array('appPackage' => 'com.example',
| dontStopAppOnReset | `boolean` | Should the app stop on reset |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/activity/start-activity.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L507)
diff --git a/docs/en/commands/device/app/README.md b/docs/en/commands/device/app/README.md
index 316ba5932..3387e25c6 100644
--- a/docs/en/commands/device/app/README.md
+++ b/docs/en/commands/device/app/README.md
@@ -3,9 +3,11 @@
## Appium API Documentation
### /docs/en/commands/device/app
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/app/background-app.md b/docs/en/commands/device/app/background-app.md
index a0355aed3..da0fbaab9 100644
--- a/docs/en/commands/device/app/background-app.md
+++ b/docs/en/commands/device/app/background-app.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
# Background App
Send the currently running app for this session to the background
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
```java
// Java
driver.runAppInBackground(Duration.ofSeconds(10));
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
```python
# Python
self.driver.background_app(10)
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.background(10);
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
// wd example
await driver.backgroundApp(10);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
```ruby
# Ruby
# ruby_lib example
background_app(10)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
# ruby_lib_core example
@driver.background_app(10)
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
```php
# PHP
$driver->backgroundApp(10);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
```csharp
// C#
// TODO C# sample
@@ -53,6 +63,7 @@ $driver->backgroundApp(10);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
## Description
Send the currently active app to the background, and either return after a certain amount of time, or leave the app deactivated.
@@ -71,8 +82,10 @@ iOS tests with XCUITest can also use the `mobile: terminateApp` method to termin
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -85,6 +98,7 @@ iOS tests with XCUITest can also use the `mobile: terminateApp` method to termin
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -99,25 +113,30 @@ iOS tests with XCUITest can also use the `mobile: terminateApp` method to termin
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
`POST /session/:session_id/appium/app/background`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
|name|type|description|
|----|----|-----------|
| seconds | `number` | How long to run app in background. |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/background-app.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L538)
diff --git a/docs/en/commands/device/app/close-app.md b/docs/en/commands/device/app/close-app.md
index 7386d6b30..b5eaaa163 100644
--- a/docs/en/commands/device/app/close-app.md
+++ b/docs/en/commands/device/app/close-app.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
# Close an App
Close an app on device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
```java
// Java
driver.closeApp();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
```python
# Python
self.driver.close_app()
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.close_app();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
// wd example
await driver.closeApp();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
```ruby
# Ruby
# ruby_lib example
close_app
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
# ruby_lib_core example
@driver.close_app
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
```php
# PHP
$driver->closeApp();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
```csharp
// C#
// TODO C# sample
@@ -55,8 +65,10 @@ $driver->closeApp();
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ $driver->closeApp();
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,23 +96,28 @@ $driver->closeApp();
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
`POST /session/:session_id/appium/app/close`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/close-app.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L532)
diff --git a/docs/en/commands/device/app/end-test-coverage.md b/docs/en/commands/device/app/end-test-coverage.md
index 0a855afc6..360b76816 100644
--- a/docs/en/commands/device/app/end-test-coverage.md
+++ b/docs/en/commands/device/app/end-test-coverage.md
@@ -1,48 +1,58 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
# End Test Coverage
Get test coverage data
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
```java
// Java
driver.endTestCoverage("Intent", "/path");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
```python
# Python
self.driver.end_test_coverage("Intent", "/path")
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
// wd example
await driver.endTestCoverageForApp("Intent", "/path");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
```ruby
# Ruby
# ruby_lib example
end_coverage("Intent", "/path")
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
# ruby_lib_core example
@driver.end_coverage("Intent", "/path")
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
```php
# PHP
$driver->endTestCoverage('Intent', '/path');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
```csharp
// C#
// TODO C# sample
@@ -52,8 +62,10 @@ $driver->endTestCoverage('Intent', '/path');
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -66,6 +78,7 @@ $driver->endTestCoverage('Intent', '/path');
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -80,16 +93,19 @@ $driver->endTestCoverage('Intent', '/path');
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
`POST /session/:session_id/appium/app/end_test_coverage`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
|name|type|description|
|----|----|-----------|
@@ -97,9 +113,11 @@ $driver->endTestCoverage('Intent', '/path');
| path | `string` | Path to .ec file |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/end-test-coverage.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L541)
diff --git a/docs/en/commands/device/app/get-app-strings.md b/docs/en/commands/device/app/get-app-strings.md
index f9d178489..05794e409 100644
--- a/docs/en/commands/device/app/get-app-strings.md
+++ b/docs/en/commands/device/app/get-app-strings.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
# Get App Strings
Get app strings
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
```java
// Java
Map appStrings = driver.getAppStringMap("en", "/path/to/file");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
```python
# Python
appStrings = self.driver.app_strings("en", "/path/to/file")
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ let appStrings = driver.getAppStrings("en");
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
// wd example
let appStrings = await driver.getAppStrings();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
```ruby
# Ruby
# ruby_lib example
app_strings("en")
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
# ruby_lib_core example
@driver.app_strings("en")
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
```php
# PHP
$strings = $driver->appStrings();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
```csharp
// C#
// TODO C# sample
@@ -55,8 +65,10 @@ $strings = $driver->appStrings();
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ $strings = $driver->appStrings();
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,16 +96,19 @@ $strings = $driver->appStrings();
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
`POST /session/:session_id/appium/app/strings`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
|name|type|description|
|----|----|-----------|
@@ -100,9 +116,11 @@ $strings = $driver->appStrings();
| stringFile | `string` | Path to the string file (optional) |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/get-app-strings.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L544)
diff --git a/docs/en/commands/device/app/install-app.md b/docs/en/commands/device/app/install-app.md
index 24fc83ecb..9ccb84c47 100644
--- a/docs/en/commands/device/app/install-app.md
+++ b/docs/en/commands/device/app/install-app.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
# Install App
Install the given app onto the device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
```java
// Java
driver.installApp("/Users/johndoe/path/to/app.apk");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
```python
# Python
self.driver.install_app('/Users/johndoe/path/to/app.apk');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.installApp('/Users/johndoe/path/to/app.apk')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
// wd example
await driver.installAppOnDevice('/Users/johndoe/path/to/app.apk');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
```ruby
# Ruby
# ruby_lib example
install_app('/Users/johndoe/path/to/app.apk')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
# ruby_lib_core example
@driver.install_app('/Users/johndoe/path/to/app.apk')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
```php
# PHP
$driver->installApp('/Users/johndoe/path/to/app.apk');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
```csharp
// C#
// TODO C# sample
@@ -53,14 +63,17 @@ $driver->installApp('/Users/johndoe/path/to/app.apk');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
## Description
iOS tests with XCUITest can also use the `mobile: installApp` method. See detailed [documentation](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-installapp).
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -73,6 +86,7 @@ iOS tests with XCUITest can also use the `mobile: installApp` method. See detail
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -87,25 +101,30 @@ iOS tests with XCUITest can also use the `mobile: installApp` method. See detail
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
`POST /wd/hub/session/:session_id/appium/device/install_app`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
|name|type|description|
|----|----|-----------|
| appPath | `string` | Path of the app being installed |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/install-app.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L418)
diff --git a/docs/en/commands/device/app/is-app-installed.md b/docs/en/commands/device/app/is-app-installed.md
index 2a0c25fc2..d4e807839 100644
--- a/docs/en/commands/device/app/is-app-installed.md
+++ b/docs/en/commands/device/app/is-app-installed.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
# Is App Installed
Check whether the specified app is installed on the device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
```java
// Java
driver.isAppInstalled("com.example.AppName");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
```python
# Python
self.driver.is_app_installed('com.example.AppName');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.isAppInstalled('com.example.AppName')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
// wd example
await driver.isAppInstalledOnDevice('com.example.AppName');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
```ruby
# Ruby
# ruby_lib example
app_installed?('com.example.AppName')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
# ruby_lib_core example
@driver.app_installed?('com.example.AppName')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
```php
# PHP
$driver->isAppInstalled('com.example.AppName')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
```csharp
// C#
// TODO C# sample
@@ -53,14 +63,17 @@ $driver->isAppInstalled('com.example.AppName')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
## Description
iOS tests with XCUITest can also use the `mobile: isAppInstalled` method. See detailed [documentation](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-isappinstalled).
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -73,6 +86,7 @@ iOS tests with XCUITest can also use the `mobile: isAppInstalled` method. See de
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -87,25 +101,30 @@ iOS tests with XCUITest can also use the `mobile: isAppInstalled` method. See de
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
`POST /wd/hub/session/:session_id/appium/device/app_installed`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
|name|type|description|
|----|----|-----------|
| bundleId | `string` | iOS bundleID or Android package name |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
Return true if installed, false if not (`boolean`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/is-app-installed.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L454)
diff --git a/docs/en/commands/device/app/launch-app.md b/docs/en/commands/device/app/launch-app.md
index a70d2154e..8f29fcc02 100644
--- a/docs/en/commands/device/app/launch-app.md
+++ b/docs/en/commands/device/app/launch-app.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
# Launch an App
Launch an app on device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
```java
// Java
driver.launchApp();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
```python
# Python
self.driver.launch_app()
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.launch();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
// wd example
await driver.launchApp();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
```ruby
# Ruby
# ruby_lib example
launch_app
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
# ruby_lib_core example
@driver.launch_app
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
```php
# PHP
$driver->launchApp();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
```csharp
// C#
// TODO C# sample
@@ -53,14 +63,17 @@ $driver->launchApp();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
## Description
iOS tests with XCUITest can also use the `mobile: launchApp` method. See detailed [documentation](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-launchapp).
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -73,6 +86,7 @@ iOS tests with XCUITest can also use the `mobile: launchApp` method. See detaile
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -87,23 +101,28 @@ iOS tests with XCUITest can also use the `mobile: launchApp` method. See detaile
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
`POST /session/:session_id/appium/app/launch`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/launch-app.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L529)
diff --git a/docs/en/commands/device/app/remove-app.md b/docs/en/commands/device/app/remove-app.md
index 9ba0cf631..b6c6f1c6b 100644
--- a/docs/en/commands/device/app/remove-app.md
+++ b/docs/en/commands/device/app/remove-app.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
# Remove App
Remove an app from the device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
```java
// Java
driver.removeApp("com.example.AppName");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
```python
# Python
self.driver.remove_app('com.example.AppName');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.removeApp('com.example.AppName')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
// wd example
await driver.removeAppFromDevice('com.example.AppName');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
```ruby
# Ruby
# ruby_lib example
remove_app('com.example.AppName')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
# ruby_lib_core example
@driver.remove_app('com.example.AppName')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
```php
# PHP
$driver->removeApp('com.example.AppName');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
```csharp
// C#
// TODO C# sample
@@ -53,14 +63,17 @@ $driver->removeApp('com.example.AppName');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
## Description
iOS tests with XCUITest can also use the `mobile: removeApp` method. See detailed [documentation](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-removeapp).
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -73,6 +86,7 @@ iOS tests with XCUITest can also use the `mobile: removeApp` method. See detaile
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -87,16 +101,19 @@ iOS tests with XCUITest can also use the `mobile: removeApp` method. See detaile
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
`POST /wd/hub/session/:session_id/appium/device/remove_app`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
|name|type|description|
|----|----|-----------|
@@ -104,9 +121,11 @@ iOS tests with XCUITest can also use the `mobile: removeApp` method. See detaile
| bundleId | `string` | iOS bundleID or Android package name |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/remove-app.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L436)
diff --git a/docs/en/commands/device/app/reset-app.md b/docs/en/commands/device/app/reset-app.md
index b7a17e52e..b97901d4d 100644
--- a/docs/en/commands/device/app/reset-app.md
+++ b/docs/en/commands/device/app/reset-app.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
# Reset App
Reset the currently running app for this session
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
```java
// Java
driver.resetApp();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
```python
# Python
self.driver.reset()
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.reset();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
// wd example
await driver.resetApp();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
```ruby
# Ruby
# ruby_lib example
reset
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
# ruby_lib_core example
@driver.reset
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
```php
# PHP
$driver->reset();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
```csharp
// C#
// TODO C# sample
@@ -55,8 +65,10 @@ $driver->reset();
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ $driver->reset();
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,23 +96,28 @@ $driver->reset();
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
`POST /session/:session_id/appium/app/reset`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/reset-app.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L535)
diff --git a/docs/en/commands/device/authentication/README.md b/docs/en/commands/device/authentication/README.md
index c044a04e2..f150d16a6 100644
--- a/docs/en/commands/device/authentication/README.md
+++ b/docs/en/commands/device/authentication/README.md
@@ -3,10 +3,13 @@
## Appium API Documentation
### /docs/en/commands/device/authentication
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/authentication/finger-print.md b/docs/en/commands/device/authentication/finger-print.md
index c8f44c9cc..3e848da11 100644
--- a/docs/en/commands/device/authentication/finger-print.md
+++ b/docs/en/commands/device/authentication/finger-print.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
# Finger print
Authenticate users by using their finger print scans on supported emulators.
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
```java
// Java
driver.fingerPrint(1);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
```python
# Python
self.driver.finger_print(1)
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ await driver.fingerprint(1);
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
// wd example
await driver.fingerprint(1);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
```ruby
# Ruby
# ruby_lib example
finger_print 1
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
# ruby_lib_core example
@driver.finger_print 1
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
```php
# PHP
// PHP Code here
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
```csharp
// C#
// CSharp Code here
@@ -53,6 +63,7 @@ finger_print 1
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
## Description
For Android emulator.
@@ -62,8 +73,10 @@ Touch ID by iOS is [here](http://appium.io/docs/en/commands/device/simulator/tou
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -76,6 +89,7 @@ Touch ID by iOS is [here](http://appium.io/docs/en/commands/device/simulator/tou
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -90,25 +104,30 @@ Touch ID by iOS is [here](http://appium.io/docs/en/commands/device/simulator/tou
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
`POST /session/:session_id/appium/device/finger_print`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
|name|type|description|
|----|----|-----------|
| fingerprintId | `number` | finger prints stored in Android Keystore system (from 1 to 10) |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/authentication/finger-print.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L379)
diff --git a/docs/en/commands/device/clipboard/get-clipboard.md b/docs/en/commands/device/clipboard/get-clipboard.md
index d58b82b6f..ccef4daae 100644
--- a/docs/en/commands/device/clipboard/get-clipboard.md
+++ b/docs/en/commands/device/clipboard/get-clipboard.md
@@ -1,10 +1,13 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
# Get Clipboard
Get the content of the system clipboard
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
```java
// Java
driver.getClipboard(ClipboardContentType.PLAINTEXT); // get plaintext
@@ -12,6 +15,7 @@ driver.getClipboardText();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
```python
# Python
self.driver.get_clipboard()
@@ -19,6 +23,7 @@ self.driver.get_clipboard_text()
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
```javascript
// Javascript
// webdriver.io example
@@ -26,28 +31,33 @@ await driver.getClipboard();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
// wd example
await driver.getClipboard();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
```ruby
# Ruby
# ruby_lib example
get_clipboard
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
# ruby_lib_core example
@driver.get_clipboard
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
```php
# PHP
// PHP Code here
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
```csharp
// C#
// CSharp Code here
@@ -55,14 +65,17 @@ get_clipboard
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
## Description
Get the content of the system clipboard
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -75,6 +88,7 @@ Get the content of the system clipboard
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -89,24 +103,29 @@ Get the content of the system clipboard
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
`POST /wd/hub/session/:session_id/appium/device/get_clipboard`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
|name|type|description|
|----|----|-----------|
| contentType | `string` | The type of the content to get. Plaintext, Image, URL. Android supports only plaintext. |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
Clipboard content as base64-encoded string or an empty string if the clipboard is empty (`string`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/get-clipboard.yml)
diff --git a/docs/en/commands/device/clipboard/set-clipboard.md b/docs/en/commands/device/clipboard/set-clipboard.md
index 3ebe399ba..3cfd4d2e9 100644
--- a/docs/en/commands/device/clipboard/set-clipboard.md
+++ b/docs/en/commands/device/clipboard/set-clipboard.md
@@ -1,10 +1,13 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
# Set Clipboard
Set the content of the system clipboard
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
```java
// Java
// base64Content is Base64-encoded content
@@ -13,6 +16,7 @@ driver.setClipboardText("happy testing");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
```python
# Python
self.driver.set_clipboard('happy testing')
@@ -20,6 +24,7 @@ self.driver.set_clipboard_text('happy testing')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
```javascript
// Javascript
// webdriver.io example
@@ -27,28 +32,33 @@ await driver.setClipboard('happy testing', 'plaintext')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
// wd example
await driver.setClipboard('happy testing', 'plaintext')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
```ruby
# Ruby
# ruby_lib example
set_clipboard content: 'happy testing'
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
# ruby_lib_core example
@driver.set_clipboard content: 'happy testing'
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
```php
# PHP
// PHP Code here
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
```csharp
// C#
// CSharp Code here
@@ -56,14 +66,17 @@ set_clipboard content: 'happy testing'
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
## Description
Set the content of the system clipboard
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -76,6 +89,7 @@ Set the content of the system clipboard
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -90,16 +104,19 @@ Set the content of the system clipboard
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
`POST /wd/hub/session/:session_id/appium/device/set_clipboard`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
|name|type|description|
|----|----|-----------|
@@ -108,8 +125,10 @@ Set the content of the system clipboard
| label | `string` | Clipboard data label for Android. |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
Response from Appium server (`string`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/clipboard/set-clipboard.yml)
diff --git a/docs/en/commands/device/emulator/power_ac.md b/docs/en/commands/device/emulator/power_ac.md
index f50bf9c59..bbec157b0 100644
--- a/docs/en/commands/device/emulator/power_ac.md
+++ b/docs/en/commands/device/emulator/power_ac.md
@@ -1,47 +1,58 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
# Emulate power state
Emulate power state change on the connected emulator.
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
```java
// Java
driver.setPowerAC(PowerACState.OFF);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
// Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
```ruby
# Ruby
# ruby_lib example
set_power_ac :on
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
# ruby_lib_core example
@driver.set_power_ac :on
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
```php
// Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
```csharp
// Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
## Description
For Android emulator.
@@ -49,8 +60,10 @@ To set the state of the battery charger to connected or not.
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -63,6 +76,7 @@ To set the state of the battery charger to connected or not.
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -77,25 +91,30 @@ To set the state of the battery charger to connected or not.
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
`POST /session/:session_id/appium/device/power_ac`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
|name|type|description|
|----|----|-----------|
| state | `string` | set the state. on or off |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_ac.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L397)
diff --git a/docs/en/commands/device/emulator/power_capacity.md b/docs/en/commands/device/emulator/power_capacity.md
index 8aee04bda..57eb5005e 100644
--- a/docs/en/commands/device/emulator/power_capacity.md
+++ b/docs/en/commands/device/emulator/power_capacity.md
@@ -1,47 +1,58 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
# Emulate power capacity
Emulate power capacity change on the connected emulator.
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
```java
// Java
driver.setPowerCapacity(100);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
// Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
```ruby
# Ruby
# ruby_lib example
set_power_capacity 50
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
# ruby_lib_core example
@driver.set_power_capacity 50
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
```php
// Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
```csharp
// Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
## Description
For Android emulator.
@@ -49,8 +60,10 @@ To set the battery percentage.
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -63,6 +76,7 @@ To set the battery percentage.
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -77,25 +91,30 @@ To set the battery percentage.
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
`POST /session/:session_id/appium/device/power_capacity`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
|name|type|description|
|----|----|-----------|
| percent | `integer` | ercentage value in range [0, 100] |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/emulator/power_capacity.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L394)
diff --git a/docs/en/commands/device/files/README.md b/docs/en/commands/device/files/README.md
index c6be2347b..ca7ad241a 100644
--- a/docs/en/commands/device/files/README.md
+++ b/docs/en/commands/device/files/README.md
@@ -3,12 +3,15 @@
## Appium API Documentation
### /docs/en/commands/device/files
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/files/pull-file.md b/docs/en/commands/device/files/pull-file.md
index 5f700d15a..95e980c57 100644
--- a/docs/en/commands/device/files/pull-file.md
+++ b/docs/en/commands/device/files/pull-file.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
# Pull File
Retrieve a file from the device's file system
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
```java
// Java
byte[] fileBase64 = driver.pullFile("/path/to/device/foo.bar");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
```python
# Python
file_base64 = self.driver.pull_file('/path/to/device/foo.bar');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ let data = driver.pullFile('/data/local/tmp/file.txt');
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
// wd example
let fileBase64 = await driver.pullFile('/path/to/device/foo.bar');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
```ruby
# Ruby
# ruby_lib example
pull_file('/data/local/tmp/file.txt')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
# ruby_lib_core example
@driver.pull_file('/data/local/tmp/file.txt')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
```php
# PHP
$data = $driver->pullFile('data/local/tmp/file.txt');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
```csharp
// C#
// TODO C# sample
@@ -55,8 +65,10 @@ $data = $driver->pullFile('data/local/tmp/file.txt');
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ $data = $driver->pullFile('data/local/tmp/file.txt');
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,25 +96,30 @@ $data = $driver->pullFile('data/local/tmp/file.txt');
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
`POST /wd/hub/session/:session_id/appium/device/pull_file`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
|name|type|description|
|----|----|-----------|
| path | `string` | Path on the device to pull file from |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
Contents of file in base64 (`string`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L486)
diff --git a/docs/en/commands/device/files/pull-folder.md b/docs/en/commands/device/files/pull-folder.md
index 52f435d64..08e26f564 100644
--- a/docs/en/commands/device/files/pull-folder.md
+++ b/docs/en/commands/device/files/pull-folder.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
# Pull Folder
Retrieve a folder from the device's file system
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
```java
// Java
byte[] folder = driver.pullFolder("/path/to/device/foo.bar");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
```python
# Python
folder_base64 = self.driver.pull_folder('/path/to/device/foo.bar');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ let data = driver.pullFolder('/data/local/tmp/file.txt');
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
// wd example
let folderBase64 = await driver.pullFolder('/path/to/device/foo.bar');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
```ruby
# Ruby
# ruby_lib example
pull_folder('/data/local/tmp/file.txt')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
# ruby_lib_core example
@driver.pull_folder('/data/local/tmp/file.txt')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
```php
# PHP
$folderBase64 = $driver->pullFolder($path);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
```csharp
// C#
// TODO C# sample
@@ -55,8 +65,10 @@ $folderBase64 = $driver->pullFolder($path);
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ $folderBase64 = $driver->pullFolder($path);
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,25 +96,30 @@ $folderBase64 = $driver->pullFolder($path);
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
`POST /wd/hub/session/:session_id/appium/device/pull_folder`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
|name|type|description|
|----|----|-----------|
| path | `string` | Path to an entire folder on the device |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
A string of Base64 encoded data, representing a zip archive of the contents of the requested folder. (`string`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-folder.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L489)
diff --git a/docs/en/commands/device/files/push-file.md b/docs/en/commands/device/files/push-file.md
index b113bd8f9..f3a0316fb 100644
--- a/docs/en/commands/device/files/push-file.md
+++ b/docs/en/commands/device/files/push-file.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
# Push File
Place a file onto the device in a particular place
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
```java
// Java
driver.pushFile("/path/to/device/foo.bar", new File("/Users/johndoe/files/foo.bar"));
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
```python
# Python
self.driver.push_file('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
```javascript
// Javascript
// webdriver.io example
@@ -25,28 +30,33 @@ driver.pushFile('/data/local/tmp/file.txt', data);
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
// wd example
await driver.pushFileToDevice('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
```ruby
# Ruby
# ruby_lib example
push_file('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
# ruby_lib_core example
@driver.push_file('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
```php
# PHP
$driver->pushFile('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
```csharp
// C#
// TODO C# sample
@@ -56,8 +66,10 @@ $driver->pushFile('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -70,6 +82,7 @@ $driver->pushFile('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -84,16 +97,19 @@ $driver->pushFile('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
`POST /wd/hub/session/:session_id/appium/device/push_file`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
|name|type|description|
|----|----|-----------|
@@ -101,9 +117,11 @@ $driver->pushFile('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
| data | `string` | Contents of file in base64 |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/push-file.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L483)
diff --git a/docs/en/commands/device/interactions/README.md b/docs/en/commands/device/interactions/README.md
index c423c040c..be4070bc1 100644
--- a/docs/en/commands/device/interactions/README.md
+++ b/docs/en/commands/device/interactions/README.md
@@ -3,9 +3,11 @@
## Appium API Documentation
### /docs/en/commands/device/interactions
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/interactions/is-locked.md b/docs/en/commands/device/interactions/is-locked.md
index 8087ecd54..e44ec46d0 100644
--- a/docs/en/commands/device/interactions/is-locked.md
+++ b/docs/en/commands/device/interactions/is-locked.md
@@ -1,20 +1,25 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
# Is Device Locked
Check whether the device is locked or not
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
```java
// Java
boolean isLocked = driver.isDeviceLocked();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
```javascript
// Javascript
// webdriver.io example
@@ -22,28 +27,33 @@ driver.isLocked();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
// wd example
let isLocked = await driver.isLocked();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
```ruby
# Ruby
# ruby_lib example
device_locked?
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
# ruby_lib_core example
@driver.device_locked?
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
```csharp
// C#
// TODO C# sample
@@ -53,8 +63,10 @@ device_locked?
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -67,6 +79,7 @@ device_locked?
| Windows | [Windows](/docs/en/drivers/windows.md) | 10+ | 1.6.0+ | All |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -81,23 +94,28 @@ device_locked?
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
`POST /session/:session_id/appium/device/is_locked`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
True if the device is locked, false if not (`boolean`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/is-locked.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L358)
diff --git a/docs/en/commands/device/interactions/lock.md b/docs/en/commands/device/interactions/lock.md
index fd9b619b4..ea439a4a5 100644
--- a/docs/en/commands/device/interactions/lock.md
+++ b/docs/en/commands/device/interactions/lock.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
# Lock
Lock the device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
```java
// Java
driver.lockDevice();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
```python
# Python
self.driver.lock();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,11 +29,13 @@ driver.lock();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
// wd example
await driver.lock();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
```ruby
# Ruby
# ruby_lib example
@@ -36,18 +43,21 @@ lock
lock(5) # lock 5 seconds
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
# ruby_lib_core example
@driver.lock
@driver.lock(5) # lock 5 seconds
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
```php
# PHP
$driver->lock(5);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
```csharp
// C#
// TODO C# sample
@@ -57,8 +67,10 @@ $driver->lock(5);
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -71,6 +83,7 @@ $driver->lock(5);
| Windows | [Windows](/docs/en/drivers/windows.md) | 10+ | 1.6.0+ | All |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -85,25 +98,30 @@ $driver->lock(5);
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
`POST /session/:session_id/appium/device/lock`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
|name|type|description|
|----|----|-----------|
| seconds | `number` | How long to lock the screen (iOS only). |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/lock.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L352)
diff --git a/docs/en/commands/device/interactions/rotate.md b/docs/en/commands/device/interactions/rotate.md
index 34140b334..b30edf275 100644
--- a/docs/en/commands/device/interactions/rotate.md
+++ b/docs/en/commands/device/interactions/rotate.md
@@ -1,20 +1,25 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
# Rotate
Rotate the device in three dimensions
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
```java
// Java
driver.rotate(new DeviceRotation(10, 10, 10));
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
```javascript
// Javascript
// webdriver.io example
@@ -22,23 +27,28 @@ driver.rotate(100, 100);
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
// wd example
driver.rotateDevice({x: 114, y: 198, duration: 5, radius: 3, rotation: 220, touchCount: 2});
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
```ruby
# Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
```csharp
// C#
// TODO C# sample
@@ -48,8 +58,10 @@ driver.rotateDevice({x: 114, y: 198, duration: 5, radius: 3, rotation: 220, touc
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -62,6 +74,7 @@ driver.rotateDevice({x: 114, y: 198, duration: 5, radius: 3, rotation: 220, touc
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -76,16 +89,19 @@ driver.rotateDevice({x: 114, y: 198, duration: 5, radius: 3, rotation: 220, touc
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
`POST /wd/hub/session/:session_id/appium/device/rotate`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
|name|type|description|
|----|----|-----------|
@@ -97,9 +113,11 @@ driver.rotateDevice({x: 114, y: 198, duration: 5, radius: 3, rotation: 220, touc
| duration | `number` | The length of hold time for the specified gesture, in seconds. |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/rotate.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L406)
diff --git a/docs/en/commands/device/interactions/shake.md b/docs/en/commands/device/interactions/shake.md
index 59a04361f..68b0859a2 100644
--- a/docs/en/commands/device/interactions/shake.md
+++ b/docs/en/commands/device/interactions/shake.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
# Shake
Perform a shake action on the device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
```java
// Java
driver.shake();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
```python
# Python
self.driver.shake();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.shake();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
// wd example
await driver.shake();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
```ruby
# Ruby
# ruby_lib example
shake
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
# ruby_lib_core example
@driver.shake
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
```php
# PHP
$driver->shake();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
```csharp
// C#
// TODO C# sample
@@ -55,8 +65,10 @@ $driver->shake();
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ $driver->shake();
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,23 +96,28 @@ $driver->shake();
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
`POST /session/:session_id/appium/device/shake`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/shake.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L346)
diff --git a/docs/en/commands/device/interactions/unlock.md b/docs/en/commands/device/interactions/unlock.md
index aa3d95447..2fe71d19f 100644
--- a/docs/en/commands/device/interactions/unlock.md
+++ b/docs/en/commands/device/interactions/unlock.md
@@ -1,10 +1,13 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
# Unlock
Unlock the device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
```java
// Java
driver.lockDevice();
@@ -12,6 +15,7 @@ driver.unlockDevice();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
```python
# Python
self.driver.lock();
@@ -19,6 +23,7 @@ self.driver.unlock();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
```javascript
// Javascript
// webdriver.io example
@@ -27,29 +32,34 @@ driver.lock()
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
// wd example
await driver.lock();
await driver.unlock();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
```ruby
# Ruby
# ruby_lib example
unlock
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
# ruby_lib_core example
@driver.unlock
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
```csharp
// C#
// TODO C# sample
@@ -59,8 +69,10 @@ unlock
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -73,6 +85,7 @@ unlock
| Windows | [Windows](/docs/en/drivers/windows.md) | 10+ | 1.6.0+ | All |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -87,23 +100,28 @@ unlock
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
`POST /session/:session_id/appium/device/unlock`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L355)
diff --git a/docs/en/commands/device/keys/README.md b/docs/en/commands/device/keys/README.md
index a7a506900..95f3dae33 100644
--- a/docs/en/commands/device/keys/README.md
+++ b/docs/en/commands/device/keys/README.md
@@ -3,9 +3,11 @@
## Appium API Documentation
### /docs/en/commands/device/keys
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/keys/hide-keyboard.md b/docs/en/commands/device/keys/hide-keyboard.md
index 139df4609..db9ad017c 100644
--- a/docs/en/commands/device/keys/hide-keyboard.md
+++ b/docs/en/commands/device/keys/hide-keyboard.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
# Hide Keyboard
Hide soft keyboard
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
```java
// Java
driver.hideKeyboard();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
```python
# Python
self.driver.hide_keyboard()
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,22 +29,26 @@ driver.hideDeviceKeyboard();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
// wd example
await driver.hideDeviceKeyboard();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
```ruby
# Ruby
# ruby_lib example
hide_keyboard
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
# ruby_lib_core example
@driver.hide_keyboard
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
```php
# PHP
$driver->hideKeyboard();
@@ -49,6 +58,7 @@ $driver->hideKeyboard(array(
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
```csharp
// C#
// TODO C# sample
@@ -58,8 +68,10 @@ $driver->hideKeyboard(array(
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -72,6 +84,7 @@ $driver->hideKeyboard(array(
| Windows | [Windows](/docs/en/drivers/windows.md) | 10+ | 1.6.0+ | All |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -86,16 +99,19 @@ $driver->hideKeyboard(array(
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
`POST /wd/hub/session/:session_id/appium/device/hide_keyboard`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
|name|type|description|
|----|----|-----------|
@@ -105,9 +121,11 @@ $driver->hideKeyboard(array(
| keyName | `string` | Key name (optional) |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/hide-keyboard.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L477)
diff --git a/docs/en/commands/device/keys/is-keyboard-shown.md b/docs/en/commands/device/keys/is-keyboard-shown.md
index 7120c2673..4a34fdfc0 100644
--- a/docs/en/commands/device/keys/is-keyboard-shown.md
+++ b/docs/en/commands/device/keys/is-keyboard-shown.md
@@ -1,44 +1,54 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
# Is Keyboard Shown
Whether or not the soft keyboard is shown
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
```java
// Java
boolean isKeyboardShown = driver.isKeyboardShown();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
// wd example
await driver.isKeyboardShown();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
```ruby
# Ruby
# ruby_lib example
is_keyboard_shown
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
# ruby_lib_core example
@driver.is_keyboard_shown
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
```php
// Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
```csharp
// Not supported
```
@@ -46,8 +56,10 @@ is_keyboard_shown
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -60,6 +72,7 @@ is_keyboard_shown
| Windows | [Windows](/docs/en/drivers/windows.md) | 10+ | 1.6.0+ | All |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -74,23 +87,28 @@ is_keyboard_shown
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
`GET /wd/hub/session/:session_id/appium/device/is_keyboard_shown`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
True if the keyboard is shown. (`boolean`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/is-keyboard-shown.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L480)
diff --git a/docs/en/commands/device/keys/long-press-keycode.md b/docs/en/commands/device/keys/long-press-keycode.md
index 2050f16d8..826c954ac 100644
--- a/docs/en/commands/device/keys/long-press-keycode.md
+++ b/docs/en/commands/device/keys/long-press-keycode.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
# Long Press Key Code
Press and hold a particular key code on the device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
```java
// Java
driver.longPressKeyCode(AndroidKeyCode.HOME);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
```python
# Python
self.driver.long_press_keycode(10);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.longPressKeyCode(10);
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
// wd example
await driver.longPressKeyCode(10);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
```ruby
# Ruby
# ruby_lib example
long_press_keycode(10)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
# ruby_lib_core example
@driver.long_press_keycode(10)
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
```csharp
// C#
// TODO C# sample
@@ -55,8 +65,10 @@ long_press_keycode(10)
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ long_press_keycode(10)
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,16 +96,19 @@ long_press_keycode(10)
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
`POST /session/:session_id/appium/device/long_press_keycode`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
|name|type|description|
|----|----|-----------|
@@ -101,9 +117,11 @@ long_press_keycode(10)
| flags | `number` | Flags for the keypress. See [Key Event](http://developer.android.com/reference/android/view/KeyEvent.html). |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/long-press-keycode.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L376)
diff --git a/docs/en/commands/device/keys/press-keycode.md b/docs/en/commands/device/keys/press-keycode.md
index a54309590..435f0c9f7 100644
--- a/docs/en/commands/device/keys/press-keycode.md
+++ b/docs/en/commands/device/keys/press-keycode.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
# Press Key Code
Press a particular key on the device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
```java
// Java
driver.pressKeyCode(AndroidKeyCode.SPACE, AndroidKeyMetastate.META_SHIFT_ON);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
```python
# Python
self.driver.press_keycode(10);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.pressKeycode(10);
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
// wd example
await driver.pressKeycode(10);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
```ruby
# Ruby
# ruby_lib example
press_keycode(10)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
# ruby_lib_core example
@driver.press_keycode(10)
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
```csharp
// C#
// TODO C# sample
@@ -55,8 +65,10 @@ press_keycode(10)
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ press_keycode(10)
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,16 +96,19 @@ press_keycode(10)
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
`POST /session/:session_id/appium/device/press_keycode`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
|name|type|description|
|----|----|-----------|
@@ -101,9 +117,11 @@ press_keycode(10)
| flags | `number` | Flags for the keypress. See [Key Event](http://developer.android.com/reference/android/view/KeyEvent.html). |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/keys/press-keycode.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L373)
diff --git a/docs/en/commands/device/network/README.md b/docs/en/commands/device/network/README.md
index b29bdf7ad..a4db2bc98 100644
--- a/docs/en/commands/device/network/README.md
+++ b/docs/en/commands/device/network/README.md
@@ -3,9 +3,11 @@
## Appium API Documentation
### /docs/en/commands/device/network
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/network/gsm-call.md b/docs/en/commands/device/network/gsm-call.md
index 02fbb459a..4f2a947ea 100644
--- a/docs/en/commands/device/network/gsm-call.md
+++ b/docs/en/commands/device/network/gsm-call.md
@@ -1,46 +1,56 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
# GSM Call
Make GSM call (Emulator only)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
```java
// Java
driver.makeGsmCall("5551234567", GsmCallActions.CALL);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
// wd example
await driver.gsmCall('555-123-4567', 'Phone');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
```ruby
# Ruby
# ruby_lib example
gsm_call(phone_number: '5551234567', action: :call)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
# ruby_lib_core example
@driver.gsm_call(phone_number: '5551234567', action: :call)
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
```php
# PHP
// TODO
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
```csharp
// C#
// TODO
@@ -50,8 +60,10 @@ gsm_call(phone_number: '5551234567', action: :call)
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -64,6 +76,7 @@ gsm_call(phone_number: '5551234567', action: :call)
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -78,16 +91,19 @@ gsm_call(phone_number: '5551234567', action: :call)
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
`POST /session/:session_id/appium/device/gsm_call`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
|name|type|description|
|----|----|-----------|
@@ -95,9 +111,11 @@ gsm_call(phone_number: '5551234567', action: :call)
| action | `string` | The action - 'call', 'accept', 'cancel', 'hold'. |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-call.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L385)
diff --git a/docs/en/commands/device/network/gsm-signal.md b/docs/en/commands/device/network/gsm-signal.md
index 0b79c0880..36013635e 100644
--- a/docs/en/commands/device/network/gsm-signal.md
+++ b/docs/en/commands/device/network/gsm-signal.md
@@ -1,46 +1,56 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
# GSM Signal
Set GSM signal strength (Emulator only)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
```java
// Java
driver.setGsmSignalStrength(GsmSignalStrength.GOOD);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
// wd example
await driver.gsmSignal(3);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
```ruby
# Ruby
# ruby_lib example
gsm_signal :good
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
# ruby_lib_core example
@driver.gsm_signal :good
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
```php
# PHP
// TODO
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
```csharp
// C#
// TODO
@@ -50,8 +60,10 @@ gsm_signal :good
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -64,6 +76,7 @@ gsm_signal :good
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -78,25 +91,30 @@ gsm_signal :good
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
`POST /session/:session_id/appium/device/gsm_signal`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
|name|type|description|
|----|----|-----------|
| signalStrengh | `string` | Signal strength in the range [0, 4] |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-signal.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L388)
diff --git a/docs/en/commands/device/network/gsm-voice.md b/docs/en/commands/device/network/gsm-voice.md
index 28591e318..ed7c41151 100644
--- a/docs/en/commands/device/network/gsm-voice.md
+++ b/docs/en/commands/device/network/gsm-voice.md
@@ -1,46 +1,56 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
# GSM Voice
Set GSM voice state (Emulator only)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
```java
// Java
driver.setGsmVoice(GsmVoiceState.HOME);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
// wd example
await driver.gsmVoice('Voice state');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
```ruby
# Ruby
# ruby_lib example
gsm_voice :home
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
# ruby_lib_core example
@driver.gsm_voice :home
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
```php
# PHP
// TODO
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
```csharp
// C#
// TODO
@@ -50,8 +60,10 @@ gsm_voice :home
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -64,6 +76,7 @@ gsm_voice :home
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -78,25 +91,30 @@ gsm_voice :home
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
`POST /session/:session_id/appium/device/gsm_voice`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
|name|type|description|
|----|----|-----------|
| state | `string` | State of GSM voice - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'. |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/gsm-voice.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L391)
diff --git a/docs/en/commands/device/network/send-sms.md b/docs/en/commands/device/network/send-sms.md
index d1a9c88cb..25a6f2473 100644
--- a/docs/en/commands/device/network/send-sms.md
+++ b/docs/en/commands/device/network/send-sms.md
@@ -1,46 +1,56 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
# Send SMS
Simulate an SMS message (Emulator only)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
```java
// Java
driver.sendSMS("555-123-4567", "Hey lol");
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
// wd example
await driver.sendSms('555-123-4567', 'Hey lol');
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
```ruby
# Ruby
# ruby_lib example
send_sms(phone_number: '555-123-4567', message: 'Hey lol')
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
# ruby_lib_core example
@driver.send_sms(phone_number: '555-123-4567', message: 'Hey lol')
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
```php
# PHP
// TODO
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
```csharp
// C#
// TODO
@@ -50,8 +60,10 @@ send_sms(phone_number: '555-123-4567', message: 'Hey lol')
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -64,6 +76,7 @@ send_sms(phone_number: '555-123-4567', message: 'Hey lol')
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -78,16 +91,19 @@ send_sms(phone_number: '555-123-4567', message: 'Hey lol')
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
`POST /session/:session_id/appium/device/send_sms`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
|name|type|description|
|----|----|-----------|
@@ -95,9 +111,11 @@ send_sms(phone_number: '555-123-4567', message: 'Hey lol')
| message | `string` | The SMS message |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/send-sms.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L382)
diff --git a/docs/en/commands/device/network/toggle-airplane-mode.md b/docs/en/commands/device/network/toggle-airplane-mode.md
index 80f256eb5..90fc6bd4d 100644
--- a/docs/en/commands/device/network/toggle-airplane-mode.md
+++ b/docs/en/commands/device/network/toggle-airplane-mode.md
@@ -1,20 +1,25 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
# Toggle Airplane Mode
Toggle airplane mode on device
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
```java
// Java
driver.toggleAirplaneMode();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
```javascript
// Javascript
// webdriver.io example
@@ -22,28 +27,33 @@ driver.toggleAirplaneMode();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
// wd example
await driver.toggleAirplaneMode();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
```ruby
# Ruby
# ruby_lib example
toggle_flight_mode
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
# ruby_lib_core example
@driver.toggle_flight_mode
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
```php
# PHP
// TODO
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
```csharp
// C#
// TODO
@@ -53,8 +63,10 @@ toggle_flight_mode
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -67,6 +79,7 @@ toggle_flight_mode
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -81,23 +94,28 @@ toggle_flight_mode
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
`POST /session/:session_id/appium/device/toggle_airplane_mode`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-airplane-mode.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L492)
diff --git a/docs/en/commands/device/network/toggle-data.md b/docs/en/commands/device/network/toggle-data.md
index bf28e797a..faa26ad71 100644
--- a/docs/en/commands/device/network/toggle-data.md
+++ b/docs/en/commands/device/network/toggle-data.md
@@ -1,20 +1,25 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
# Toggle Data
Switch the state of data service
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
```java
// Java
driver.toggleData();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
```javascript
// Javascript
// webdriver.io example
@@ -22,28 +27,33 @@ driver.toggleData();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
// wd example
await driver.toggleData();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
```ruby
# Ruby
# ruby_lib example
toggle_data
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
# ruby_lib_core example
@driver.toggle_data
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
```php
# PHP
// TODO
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
```csharp
// C#
// TODO
@@ -53,8 +63,10 @@ toggle_data
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -67,6 +79,7 @@ toggle_data
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -81,23 +94,28 @@ toggle_data
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
`POST /session/:session_id/appium/device/toggle_data`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-data.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L495)
diff --git a/docs/en/commands/device/network/toggle-location-services.md b/docs/en/commands/device/network/toggle-location-services.md
index a17a9db73..df4f83eea 100644
--- a/docs/en/commands/device/network/toggle-location-services.md
+++ b/docs/en/commands/device/network/toggle-location-services.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
# Toggle Location Services
Switch the state of the location service
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
```java
// Java
driver.toggleLocationServices();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
```python
# Python
self.driver.toggle_location_services();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.toggleLocationServices();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
// wd example
await driver.toggleLocationServices();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
```ruby
# Ruby
# ruby_lib example
toggle_location_services
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
# ruby_lib_core example
@driver.toggle_location_services
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
```php
# PHP
// TODO
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
```csharp
// C#
// TODO
@@ -55,8 +65,10 @@ toggle_location_services
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ toggle_location_services
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,23 +96,28 @@ toggle_location_services
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
`POST /session/:session_id/appium/device/toggle_location_services`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-location-services.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L501)
diff --git a/docs/en/commands/device/network/toggle-wifi.md b/docs/en/commands/device/network/toggle-wifi.md
index f48408aea..f9906b272 100644
--- a/docs/en/commands/device/network/toggle-wifi.md
+++ b/docs/en/commands/device/network/toggle-wifi.md
@@ -1,20 +1,25 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
# Toggle WiFi
Switch the state of the wifi service
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
```java
// Java
driver.toggleWifi();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
```javascript
// Javascript
// webdriver.io example
@@ -22,28 +27,33 @@ driver.toggleWiFi();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
// wd example
await driver.toggleWiFi();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
```ruby
# Ruby
# ruby_lib example
toggle_wifi
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
# ruby_lib_core example
@driver.toggle_wifi
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
```php
# PHP
// TODO
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
```csharp
// C#
// TODO
@@ -53,8 +63,10 @@ toggle_wifi
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -67,6 +79,7 @@ toggle_wifi
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -81,23 +94,28 @@ toggle_wifi
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
`POST /session/:session_id/appium/device/toggle_wifi`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/network/toggle-wifi.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L498)
diff --git a/docs/en/commands/device/performance-data/README.md b/docs/en/commands/device/performance-data/README.md
index 2bd88a988..68d896666 100644
--- a/docs/en/commands/device/performance-data/README.md
+++ b/docs/en/commands/device/performance-data/README.md
@@ -3,11 +3,14 @@
## Appium API Documentation
### /docs/en/commands/device/performance-data
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/performance-data/get-performance-data.md b/docs/en/commands/device/performance-data/get-performance-data.md
index 88a19f596..10795eacc 100644
--- a/docs/en/commands/device/performance-data/get-performance-data.md
+++ b/docs/en/commands/device/performance-data/get-performance-data.md
@@ -1,46 +1,56 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
# Get Performance Data
Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
```java
// Java
List> performanceData = driver.getPerformanceData("my.app.package", "cpuinfo", 5);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
// wd example
await driver.getPerformanceData('my.app.package', 'cpuinfo', 5);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
```ruby
# Ruby
# ruby_lib example
get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo', data_read_timeout: 10
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
# ruby_lib_core example
@driver.get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo', data_read_timeout: 10
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
```csharp
// C#
// TODO C# sample
@@ -50,8 +60,10 @@ get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -64,6 +76,7 @@ get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -78,16 +91,19 @@ get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
`POST /session/:session_id/appium/getPerformanceData`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
|name|type|description|
|----|----|-----------|
@@ -96,9 +112,11 @@ get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo
| data_read_timeout | `number` | The number of attempts to read (optional) |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
The information type of the system state which is supported to read as like cpu, memory, network traffic, and battery (`array`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/get-performance-data.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L370)
diff --git a/docs/en/commands/device/performance-data/performance-data-types.md b/docs/en/commands/device/performance-data/performance-data-types.md
index e6d50f045..834107326 100644
--- a/docs/en/commands/device/performance-data/performance-data-types.md
+++ b/docs/en/commands/device/performance-data/performance-data-types.md
@@ -1,46 +1,56 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
# Get Performance Data Types
Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
```java
// Java
List performanceTypes = driver.getSupportedPerformanceDataTypes();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
// wd example
await driver.getSupportedPerformanceDataTypes();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
```ruby
# Ruby
# ruby_lib example
get_performance_data_types
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
# ruby_lib_core example
@driver.get_performance_data_types
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
```csharp
// C#
// TODO C# sample
@@ -50,8 +60,10 @@ get_performance_data_types
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -64,6 +76,7 @@ get_performance_data_types
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -78,23 +91,28 @@ get_performance_data_types
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
`POST /session/:session_id/appium/performanceData/types`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
The available performance data types (cpuinfo|batteryinfo|networkinfo|memoryinfo) (`array`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/performance-data/performance-data-types.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L367)
diff --git a/docs/en/commands/device/recording-screen/README.md b/docs/en/commands/device/recording-screen/README.md
index e48742d71..a47d54eef 100644
--- a/docs/en/commands/device/recording-screen/README.md
+++ b/docs/en/commands/device/recording-screen/README.md
@@ -3,11 +3,14 @@
## Appium API Documentation
### /docs/en/commands/device/recording-screen
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/recording-screen/start-recording-screen.md b/docs/en/commands/device/recording-screen/start-recording-screen.md
index ae6e34139..550dd8e56 100644
--- a/docs/en/commands/device/recording-screen/start-recording-screen.md
+++ b/docs/en/commands/device/recording-screen/start-recording-screen.md
@@ -1,10 +1,13 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
# Start Recording Screen
Start recording screen
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
```java
// Java
driver.startRecordingScreen();
@@ -12,21 +15,25 @@ driver.startRecordingScreen(new BaseStartScreenRecordingOptions(....));
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
```python
# Python
self.driver.start_recording_screen()
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
// wd example
await driver.startRecordingScreen();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
```ruby
# Ruby
# ruby_lib example
@@ -35,6 +42,7 @@ start_recording_screen video_size: '1280x720', time_limit: '180', bit_rate: '500
start_recording_screen video_type: 'h264', time_limit: '260' # iOS
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
# ruby_lib_core example
@driver.start_recording_screen
@driver.start_recording_screen video_size: '1280x720', time_limit: '180', bit_rate: '5000000' # Android
@@ -42,12 +50,14 @@ start_recording_screen video_type: 'h264', time_limit: '260' # iOS
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
```csharp
// C#
// TODO C# sample
@@ -57,8 +67,10 @@ start_recording_screen video_type: 'h264', time_limit: '260' # iOS
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -71,6 +83,7 @@ start_recording_screen video_type: 'h264', time_limit: '260' # iOS
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -85,16 +98,19 @@ start_recording_screen video_type: 'h264', time_limit: '260' # iOS
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
`POST /session/:session_id/appium/start_recording_screen`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
|name|type|description|
|----|----|-----------|
@@ -112,9 +128,11 @@ start_recording_screen video_type: 'h264', time_limit: '260' # iOS
| bugReport | `string` | (Android Only) Set it to `true` in order to display additional information on the video overlay, such as a timestamp, that is helpful in videos captured to illustrate bugs. This option is only supported since API level 27 (Android O). |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L361)
diff --git a/docs/en/commands/device/recording-screen/stop-recording-screen.md b/docs/en/commands/device/recording-screen/stop-recording-screen.md
index ab73bef08..6aae7f0f1 100644
--- a/docs/en/commands/device/recording-screen/stop-recording-screen.md
+++ b/docs/en/commands/device/recording-screen/stop-recording-screen.md
@@ -1,10 +1,13 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
# Stop Recording Screen
Stop recording screen
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
```java
// Java
driver.stopRecordingScreen();
@@ -12,21 +15,25 @@ driver.stopRecordingScreen(new BaseStopScreenRecordingOptions(....));
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
```python
# Python
self.driver.stop_recording_screen()
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
// wd example
await driver.stopRecordingScreen();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
```ruby
# Ruby
# ruby_lib example
@@ -34,18 +41,21 @@ stop_recording_screen
stop_recording_screen remote_path: 'https://example.com', user: 'example', pass: 'pass', method: 'POST'
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
# ruby_lib_core example
@driver.stop_recording_screen
@driver.stop_recording_screen remote_path: 'https://example.com', user: 'example', pass: 'pass', method: 'POST'
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
```csharp
// C#
// TODO C# sample
@@ -55,8 +65,10 @@ stop_recording_screen remote_path: 'https://example.com', user: 'example', pass:
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ stop_recording_screen remote_path: 'https://example.com', user: 'example', pass:
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,10 +96,12 @@ stop_recording_screen remote_path: 'https://example.com', user: 'example', pass:
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
`POST /session/:session_id/appium/stop_recording_screen`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
|name|description|
|----|-----------|
@@ -96,13 +111,16 @@ stop_recording_screen remote_path: 'https://example.com', user: 'example', pass:
|method|The http multipart upload method name. The 'PUT' one is used by default.|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
Base64 encoded string. If remote_path is set, the response is empty string. (`string`)
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L364)
diff --git a/docs/en/commands/device/simulator/README.md b/docs/en/commands/device/simulator/README.md
index 16e509467..50c21d09b 100644
--- a/docs/en/commands/device/simulator/README.md
+++ b/docs/en/commands/device/simulator/README.md
@@ -3,11 +3,14 @@
## Appium API Documentation
### /docs/en/commands/device/simulator
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/simulator/toggle-touch-id-enrollment.md b/docs/en/commands/device/simulator/toggle-touch-id-enrollment.md
index 92471a482..c49674104 100644
--- a/docs/en/commands/device/simulator/toggle-touch-id-enrollment.md
+++ b/docs/en/commands/device/simulator/toggle-touch-id-enrollment.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
# Toggle Touch ID Enrollment
Toggle the simulator being [enrolled](https://support.apple.com/en-ca/ht201371) to accept touchId (iOS Simulator only)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
```java
// Java
driver.toggleTouchIDEnrollment(true);
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
```python
# Python
self.driver.toggle_touch_id_enrollment()
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.toggleTouchIdEnrollment(true);
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
// wd example
await driver.toggleTouchIdEnrollment();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
```ruby
# Ruby
# ruby_lib example
toggle_touch_id_enrollment
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
# ruby_lib_core example
@driver.toggle_touch_id_enrollment
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
```csharp
// C#
// TODO C# sample
@@ -53,6 +63,7 @@ toggle_touch_id_enrollment
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
## Description
To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true. When `allowTouchIdEnroll` is set to true
@@ -62,8 +73,10 @@ This call will only work if the Appium process or its parent application (e.g.,
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -76,6 +89,7 @@ This call will only work if the Appium process or its parent application (e.g.,
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -90,25 +104,30 @@ This call will only work if the Appium process or its parent application (e.g.,
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
`POST /session/:session_id/appium/simulator/toggle_touch_id_enrollment`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
|name|type|description|
|----|----|-----------|
| enabled | `boolean` | If true, enable, if falsey disable, otherwise toggle (optional) |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L526)
diff --git a/docs/en/commands/device/simulator/touch-id.md b/docs/en/commands/device/simulator/touch-id.md
index 377308e35..ae43e548c 100644
--- a/docs/en/commands/device/simulator/touch-id.md
+++ b/docs/en/commands/device/simulator/touch-id.md
@@ -1,10 +1,13 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
# Perform Touch ID
Simulate a [touch id](https://support.apple.com/en-ca/ht201371) event (iOS Simulator only)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
```java
// Java
driver.performTouchID(false); // Simulates a failed touch
@@ -12,6 +15,7 @@ driver.performTouchID(true); // Simulates a passing touch
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
```python
# Python
self.driver.touch_id(false); # Simulates a failed touch
@@ -19,6 +23,7 @@ self.driver.touch_id(true); # Simulates a passing touch
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
```javascript
// Javascript
// webdriver.io example
@@ -27,12 +32,14 @@ driver.touchId(true); // Simulates a passing touch
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
// wd example
await driver.touchId(false); // Simulates a failed touch
await driver.touchId(true); // Simulates a failed touch
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
```ruby
# Ruby
# ruby_lib example
@@ -40,18 +47,21 @@ touch_id(false)
touch_id(true)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
# ruby_lib_core example
@driver.touch_id(false) # Simulates a failed touch
@driver.touch_id(true) # Simulates a passing touch
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
```php
# PHP
// TODO PHP sample
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
```csharp
// C#
// TODO C# sample
@@ -59,6 +69,7 @@ touch_id(true)
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
## Description
To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true and the Simulator
@@ -73,8 +84,10 @@ Finger Print by Android is [here](http://appium.io/docs/en/commands/device/authe
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -87,6 +100,7 @@ Finger Print by Android is [here](http://appium.io/docs/en/commands/device/authe
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -101,26 +115,31 @@ Finger Print by Android is [here](http://appium.io/docs/en/commands/device/authe
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
`POST /session/:session_id/appium/simulator/touch_id`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
|name|type|description|
|----|----|-----------|
| match | `boolean` | Are we simulating a successful touch (true) or a failed touch (false) |
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/touch-id.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L523)
* [Appium Docs](https://github.com/appium/appium-xcuitest-driver/blob/master/docs/touch-id.md)
diff --git a/docs/en/commands/device/system/README.md b/docs/en/commands/device/system/README.md
index 3d553d35c..c5ec9cc1c 100644
--- a/docs/en/commands/device/system/README.md
+++ b/docs/en/commands/device/system/README.md
@@ -3,12 +3,15 @@
## Appium API Documentation
### /docs/en/commands/device/system
+ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
-
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
diff --git a/docs/en/commands/device/system/open-notifications.md b/docs/en/commands/device/system/open-notifications.md
index cd4fb1765..7236a0307 100644
--- a/docs/en/commands/device/system/open-notifications.md
+++ b/docs/en/commands/device/system/open-notifications.md
@@ -1,22 +1,27 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
# Open Notifications
Open Android notifications (Emulator only)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
```java
// Java
driver.openNotifications();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
```python
# Python
self.driver.open_notifications();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
```javascript
// Javascript
// webdriver.io example
@@ -24,28 +29,33 @@ driver.openNotifications();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
// wd example
await driver.openNotifications();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
```ruby
# Ruby
# ruby_lib example
open_notifications();
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
# ruby_lib_core example
@driver.open_notifications();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
```php
# PHP
$driver->openNotifications();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
```csharp
// C#
// TODO
@@ -55,8 +65,10 @@ $driver->openNotifications();
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -69,6 +81,7 @@ $driver->openNotifications();
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -83,23 +96,28 @@ $driver->openNotifications();
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
`POST /session/:session_id/appium/device/open_notifications`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
null
## See Also
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/open-notifications.yml)
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L504)
diff --git a/docs/en/commands/device/system/system-bars.md b/docs/en/commands/device/system/system-bars.md
index fece80997..684c794d1 100644
--- a/docs/en/commands/device/system/system-bars.md
+++ b/docs/en/commands/device/system/system-bars.md
@@ -1,44 +1,54 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
# Get System Bars
Retrieve visibility and bounds information of the status and navigation bars
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
## Example Usage
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
```java
// Java
Map systemBars = driver.getSystemBars();
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
```python
# Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
```javascript
// Not supported
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
// Not supported
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
```ruby
# Ruby
# ruby_lib example
get_system_bars
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
# ruby_lib_core example
@driver.get_system_bars
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
```php
# PHP
// TODO
```
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
```csharp
// C#
// TODO
@@ -48,8 +58,10 @@ get_system_bars
## Support
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
### Appium Server
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
@@ -62,6 +74,7 @@ get_system_bars
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
### Appium Clients
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
|Language|Support|Documentation|
|--------|-------|-------------|
@@ -76,23 +89,28 @@ get_system_bars
## HTTP API Specifications
### Endpoint
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
`GET /session/:session_id/appium/device/system_bars`
### URL Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
### JSON Parameters
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
None
### Response
+[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-bars.yml)
Information about visibility and bounds of status and navigation bar (`array