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.) +
  • Clipboard
  • +
  • Emulator
  • Files
  • +[//]: # (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.) +
  • Clipboard
  • +
  • Emulator
  • Files
  • +[//]: # (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`) ## See Also +[//]: # (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) * [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L517) diff --git a/docs/en/commands/device/system/system-time.md b/docs/en/commands/device/system/system-time.md index 6f3b3d3ae..496a97629 100644 --- a/docs/en/commands/device/system/system-time.md +++ b/docs/en/commands/device/system/system-time.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/system-time.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.yml) # Get System Time Get the time on the device +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.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-time.yml) ```java // Java String time = driver.getDeviceTime(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.yml) ```python # Python time = self.driver.device_time() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let time = driver.getDeviceTime(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.yml) // wd example let time = await driver.getDeviceTime(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.yml) ```ruby # Ruby # ruby_lib example device_time +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.yml) # ruby_lib_core example @driver.device_time ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.yml) ```php # PHP $time = $driver->getDeviceTime(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.yml) ```csharp // C# // TODO @@ -55,8 +65,10 @@ $time = $driver->getDeviceTime(); ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.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-time.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ $time = $driver->getDeviceTime(); | 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-time.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,23 +96,28 @@ $time = $driver->getDeviceTime(); ## 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-time.yml) `GET /session/:session_id/appium/device/system_time` ### 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-time.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-time.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-time.yml) Time on the device (`string`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/system/system-time.yml) * [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L349) diff --git a/docs/en/commands/element/README.md b/docs/en/commands/element/README.md index e38539e0d..25e1813da 100644 --- a/docs/en/commands/element/README.md +++ b/docs/en/commands/element/README.md @@ -3,9 +3,11 @@ ## Appium API Documentation ### /docs/en/commands/element + [//]: # (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/element/actions/README.md b/docs/en/commands/element/actions/README.md index 748ad30b2..5332314f9 100644 --- a/docs/en/commands/element/actions/README.md +++ b/docs/en/commands/element/actions/README.md @@ -3,12 +3,15 @@ ## Appium API Documentation ### /docs/en/commands/element/actions + [//]: # (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/element/actions/clear.md b/docs/en/commands/element/actions/clear.md index a97cdff33..680e7ccdf 100644 --- a/docs/en/commands/element/actions/clear.md +++ b/docs/en/commands/element/actions/clear.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/element/actions/clear.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) # Clear Element Clear an element's value +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) ```java // Java MobileElement element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ element.clear(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) ```python # Python self.driver.find_element_by_accessibility_id('SomeAccessibilityID').clear() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) ```javascript // Javascript // webdriver.io example @@ -25,29 +30,34 @@ driver.clearElement("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); await element.clear(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, "SomeAccessibilityID").clear +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, "SomeAccessibilityID").clear ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.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/element/actions/clear.yml) ```csharp // C# // TODO C# sample @@ -57,8 +67,10 @@ find_element(:accessibility_id, "SomeAccessibilityID").clear ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -71,6 +83,7 @@ find_element(:accessibility_id, "SomeAccessibilityID").clear | 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/element/actions/clear.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -85,10 +98,12 @@ find_element(:accessibility_id, "SomeAccessibilityID").clear ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) `POST /wd/hub/session/:session_id/element/:element_id/clear` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) |name|description| |----|-----------| @@ -96,14 +111,17 @@ find_element(:accessibility_id, "SomeAccessibilityID").clear |element_id|ID of the element to clear.| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/clear.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-element-tag-name) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidclear) diff --git a/docs/en/commands/element/actions/click.md b/docs/en/commands/element/actions/click.md index 5e2c4a861..1045178ba 100644 --- a/docs/en/commands/element/actions/click.md +++ b/docs/en/commands/element/actions/click.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/element/actions/click.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) # Click Click element at its center point. +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) ```java // Java MobileElement el = driver.findElementByAccessibilityId("SomeId"); @@ -12,6 +15,7 @@ el.click(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) ```python # Python el = self.driver.find_element_by_accessibility_id('SomeId') @@ -19,6 +23,7 @@ el.click(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) ```javascript // Javascript // webdriver.io example @@ -26,29 +31,34 @@ driver.click('#SomeId'); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) // wd example let element = await driver.elementByAccessibilityId('id', 'SomeId'); await element.click(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, 'SomeId').click +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, 'SomeId').click ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) ```php # PHP $driver->byAccessibilityId('SomeId')->click(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) ```csharp // C# // TODO @@ -56,6 +66,7 @@ $driver->byAccessibilityId('SomeId')->click(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) ## Description Clicks element at its center point. If the element's center point is obscured by another element, an element click intercepted error is returned. If the element is outside the viewport, an element not interactable error is returned. @@ -63,8 +74,10 @@ Not all drivers automatically scroll the element into view and may need to be sc ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -77,6 +90,7 @@ Not all drivers automatically scroll the element into view and may need to be sc | 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/element/actions/click.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -91,10 +105,12 @@ Not all drivers automatically scroll the element into view and may need to be sc ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) `POST /wd/hub/session/:session_id/element/:element_id/click` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) |name|description| |----|-----------| @@ -102,14 +118,17 @@ Not all drivers automatically scroll the element into view and may need to be sc |element_id|UUID of the element| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/click.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#element-click) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidclick) diff --git a/docs/en/commands/element/actions/send-keys.md b/docs/en/commands/element/actions/send-keys.md index b9162f0d7..8a1be6e11 100644 --- a/docs/en/commands/element/actions/send-keys.md +++ b/docs/en/commands/element/actions/send-keys.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/element/actions/send-keys.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) # Send Keys Send a sequence of key strokes to an element +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) ```java // Java MobileElement element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ element.sendKeys("Hello world!"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) ```python # Python self.driver.find_element_by_accessibility_id('SomeAccessibilityID').send_keys('Hello world!') ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) ```javascript // Javascript // webdriver.io example @@ -25,23 +30,27 @@ driver.setValue("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); await element.type("Hello world!") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, "SomeAccessibilityID").send_keys("Hello World!") +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, "SomeAccessibilityID").send_keys("Hello World!") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) ```php # PHP $el = $this->byAccessibilityId('SomeAccessibilityID'); @@ -49,6 +58,7 @@ $el->setText('Hello world!'); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) ```csharp // C# // TODO C# sample @@ -56,6 +66,7 @@ $el->setText('Hello world!'); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) ## Description Any UTF-8 character may be specified, however, if the server does not support native key events, it should simulate key strokes for a standard US keyboard layout. The Unicode Private Use Area code points, 0xE000-0xF8FF, are used to represent pressable, non-text keys (see table below). @@ -63,8 +74,10 @@ Any UTF-8 character may be specified, however, if the server does not support na ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -77,6 +90,7 @@ Any UTF-8 character may be specified, however, if the server does not support na | 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/element/actions/send-keys.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -91,10 +105,12 @@ Any UTF-8 character may be specified, however, if the server does not support na ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) `POST /wd/hub/session/:session_id/element/value` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) |name|description| |----|-----------| @@ -102,16 +118,19 @@ Any UTF-8 character may be specified, however, if the server does not support na |element_id|ID of the element to send keys to.| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) |name|type|description| |----|----|-----------| | value | `array` | The sequence of keys to type. An array must be provided. The server should flatten the array items to a single string to be typed. | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/actions/send-keys.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-element-send-keys) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidvalue) diff --git a/docs/en/commands/element/attributes/README.md b/docs/en/commands/element/attributes/README.md index 6683c71f4..15585dfbf 100644 --- a/docs/en/commands/element/attributes/README.md +++ b/docs/en/commands/element/attributes/README.md @@ -3,9 +3,11 @@ ## Appium API Documentation ### /docs/en/commands/element/attributes + [//]: # (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/element/attributes/attribute.md b/docs/en/commands/element/attributes/attribute.md index 0795a9186..4ec8ac22c 100644 --- a/docs/en/commands/element/attributes/attribute.md +++ b/docs/en/commands/element/attributes/attribute.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/element/attributes/attribute.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) # Get Element Attribute Get the value of an element's attribute +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) ```java // Java List element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ String tagName = element.getAttribute("content-desc"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) ```python # Python tagName = self.driver.find_element_by_accessibility_id('SomeAccessibilityID').get_attribute('content-desc') ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) ```javascript // Javascript // webdriver.io example @@ -25,23 +30,27 @@ let attribute = driver.getAttribute("~SomeAccessibilityId", "content-desc"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let tagName = await element.getAttribute("content-desc"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, 'SomeAccessibilityID').attribute("content-desc") +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, 'SomeAccessibilityID').attribute("content-desc") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) ```php # PHP $el = $this->byAccessibilityId('SomeAccessibilityID'); @@ -49,6 +58,7 @@ $name = $el->attribute('name'); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) ```csharp // C# // TODO C# sample @@ -58,8 +68,10 @@ $name = $el->attribute('name'); ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -72,6 +84,7 @@ $name = $el->attribute('name'); | 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/element/attributes/attribute.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -86,10 +99,12 @@ $name = $el->attribute('name'); ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) `GET /wd/hub/session/:session_id/elements/:element_id/attribute/:name` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) |name|description| |----|-----------| @@ -98,14 +113,17 @@ $name = $el->attribute('name'); |name|The name of the attribute| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) The value of the attribute or null if not set (`string`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/attribute.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-element-attribute) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidattributename) diff --git a/docs/en/commands/element/attributes/css-property.md b/docs/en/commands/element/attributes/css-property.md index 47f1e7856..7755e8aa1 100644 --- a/docs/en/commands/element/attributes/css-property.md +++ b/docs/en/commands/element/attributes/css-property.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/element/attributes/css-property.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) # Get Element CSS Value Query the value of a web element's computed CSS property +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) ```java // Java List element = (MobileElement) driver.findElementById("SomeId"); @@ -12,12 +15,14 @@ String cssProperty = element.getCssValue("style"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) ```python # Python cssProperty = self.driver.find_element_by_accessibility_id('SomeId').value_of_css_property("style") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) ```javascript // Javascript // webdriver.io example @@ -25,29 +30,34 @@ let cssProperty = driver.getCssProperty("~SomeId", "style"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) // wd example let element = await driver.elementById("SomeId"); let cssProperty = await element.getComputedCss(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) ```ruby # Ruby # ruby_lib example find_element(:id, 'SomeId').css_value +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) # ruby_lib_core example @driver.find_element(:id, 'SomeId').css_value ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.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/element/attributes/css-property.yml) ```csharp // C# // TODO C# sample @@ -55,6 +65,7 @@ find_element(:id, 'SomeId').css_value ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) ## Description The CSS property to query should be specified using the CSS property name, not the JavaScript property name (e.g. background-color instead of backgroundColor). @@ -63,8 +74,10 @@ This command only applies to webview contexts ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -77,6 +90,7 @@ This command only applies to webview contexts | 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/element/attributes/css-property.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -91,10 +105,12 @@ This command only applies to webview contexts ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) `GET /wd/hub/session/:session_id/elements/:element_id/css/:property_name` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) |name|description| |----|-----------| @@ -103,14 +119,17 @@ This command only applies to webview contexts |property_name|Name of the CSS property| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) Value of the CSS property (`string`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/css-property.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-element-css-value) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidcsspropertyname) diff --git a/docs/en/commands/element/attributes/displayed.md b/docs/en/commands/element/attributes/displayed.md index 58714460e..a5d484e44 100644 --- a/docs/en/commands/element/attributes/displayed.md +++ b/docs/en/commands/element/attributes/displayed.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/element/attributes/displayed.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) # Is Element Displayed Determine if an element is currently displayed +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) ```java // Java MobileElement element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ boolean isDisplayed = element.isDisplayed(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) ```python # Python self.driver.find_element_by_accessibility_id('SomeAccessibilityID').is_displayed() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) ```javascript // Javascript // webdriver.io example @@ -25,23 +30,27 @@ let isDisplayed = driver.elementIdDisplayed("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let isDisplayed = await element.isDisplayed(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, "SomeAccessibilityID").displayed? +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, "SomeAccessibilityID").displayed? ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) ```php # PHP $el = $this->byAccessibilityId('SomeAccessibilityID'); @@ -49,6 +58,7 @@ $isDisplayed = $el->displayed(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) ```csharp // C# // TODO C# sample @@ -58,8 +68,10 @@ $isDisplayed = $el->displayed(); ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -72,6 +84,7 @@ $isDisplayed = $el->displayed(); | 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/element/attributes/displayed.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -86,10 +99,12 @@ $isDisplayed = $el->displayed(); ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) `GET /wd/hub/session/:session_id/element/:element_id/displayed` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) |name|description| |----|-----------| @@ -97,13 +112,16 @@ $isDisplayed = $el->displayed(); |element_id|ID of the element to check if it is displayed| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) Whether the element is displayed (`boolean`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/displayed.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementiddisplayed) diff --git a/docs/en/commands/element/attributes/enabled.md b/docs/en/commands/element/attributes/enabled.md index 761e3b790..c53ddaac4 100644 --- a/docs/en/commands/element/attributes/enabled.md +++ b/docs/en/commands/element/attributes/enabled.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/element/attributes/enabled.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) # Is Element Enabled Determine if an element is currently enabled +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) ```java // Java MobileElement element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ boolean isEnabled = element.isEnabled(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) ```python # Python self.driver.find_element_by_accessibility_id('SomeAccessibilityID').is_enabled() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) ```javascript // Javascript // webdriver.io example @@ -25,29 +30,34 @@ let isEnabled = driver.isEnabled("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let isEnabled = await element.isEnabled(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, "SomeAccessibilityID").enabled? +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, "SomeAccessibilityID").enabled? ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.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/element/attributes/enabled.yml) ```csharp // C# // TODO C# sample @@ -57,8 +67,10 @@ find_element(:accessibility_id, "SomeAccessibilityID").enabled? ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -71,6 +83,7 @@ find_element(:accessibility_id, "SomeAccessibilityID").enabled? | 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/element/attributes/enabled.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -85,10 +98,12 @@ find_element(:accessibility_id, "SomeAccessibilityID").enabled? ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) `GET /wd/hub/session/:session_id/element/:element_id/enabled` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) |name|description| |----|-----------| @@ -96,14 +111,17 @@ find_element(:accessibility_id, "SomeAccessibilityID").enabled? |element_id|ID of the element to check if it is enabled| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) Whether the element is enabled (`boolean`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/enabled.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-is-element-enabled) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidenabled) diff --git a/docs/en/commands/element/attributes/location-in-view.md b/docs/en/commands/element/attributes/location-in-view.md index ae4328325..ace8a80f9 100644 --- a/docs/en/commands/element/attributes/location-in-view.md +++ b/docs/en/commands/element/attributes/location-in-view.md @@ -1,18 +1,23 @@ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) # Get Element Location in View Determine an element's location on the screen once it has been scrolled into view (mainly an internal command and not supported by all clients) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) ```java // Not supported ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) ```python # Not supported ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) ```javascript // Javascript // webdriver.io example @@ -20,22 +25,27 @@ let location = driver.getLocationInView("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let location = await element.getLocationInView(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) ```ruby # Not supported +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) # Not supported ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) ```php // Not supported ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) ```csharp // Not supported ``` @@ -43,8 +53,10 @@ let location = await element.getLocationInView(); ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -57,6 +69,7 @@ let location = await element.getLocationInView(); | 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/element/attributes/location-in-view.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -71,10 +84,12 @@ let location = await element.getLocationInView(); ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) `GET /wd/hub/session/:session_id/elements/:element_id/location_in_view` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) |name|description| |----|-----------| @@ -82,10 +97,12 @@ let location = await element.getLocationInView(); |element_id|ID of the element to get the location-in-view of| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) |name|type|description| |----|----|-----------| @@ -93,5 +110,6 @@ None | y | `number` | Y coordinate | ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidlocation_in_view) diff --git a/docs/en/commands/element/attributes/location.md b/docs/en/commands/element/attributes/location.md index eb9aa7f74..5e4f8f654 100644 --- a/docs/en/commands/element/attributes/location.md +++ b/docs/en/commands/element/attributes/location.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/element/attributes/location.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) # Get Element Location Determine an element's location on the page or screen +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) ```java // Java List element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ Point location = element.getLocation(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) ```python # Python location = self.driver.find_element_by_accessibility_id('SomeAccessibilityID').location ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) ```javascript // Javascript // webdriver.io example @@ -25,23 +30,27 @@ let location = driver.getLocation("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let location = await element.getLocation(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, 'SomeAccessibilityID').location +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, 'SomeAccessibilityID').location ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) ```php # PHP $el = $this->byAccessibilityId('SomeAccessibilityID'); @@ -49,6 +58,7 @@ $location = $el->location(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) ```csharp // C# // TODO C# sample @@ -56,13 +66,16 @@ $location = $el->location(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) ## Description The point (0, 0) refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with x and y properties ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -75,6 +88,7 @@ The point (0, 0) refers to the upper-left corner of the page. The element's coor | 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/element/attributes/location.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -89,10 +103,12 @@ The point (0, 0) refers to the upper-left corner of the page. The element's coor ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) `GET /wd/hub/session/:session_id/elements/:element_id/location` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) |name|description| |----|-----------| @@ -100,10 +116,12 @@ The point (0, 0) refers to the upper-left corner of the page. The element's coor |element_id|ID of the element to get the location of| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) |name|type|description| |----|----|-----------| @@ -111,5 +129,6 @@ None | y | `number` | Y coordinate | ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidlocation) diff --git a/docs/en/commands/element/attributes/name.md b/docs/en/commands/element/attributes/name.md index 946c0f8b6..3f0f0e22b 100644 --- a/docs/en/commands/element/attributes/name.md +++ b/docs/en/commands/element/attributes/name.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/element/attributes/name.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) # Get Tag Name Get an element's tag name +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) ```java // Java List element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ String tagName = element.getTagName(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) ```python # Python tagName = self.driver.find_element_by_accessibility_id('SomeAccessibilityID').tag_name ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) ```javascript // Javascript // webdriver.io example @@ -25,29 +30,34 @@ let tagName = driver.getTagName("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let tagName = await element.getTagName(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, 'SomeAccessibilityID').tag_name +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, 'SomeAccessibilityID').tag_name ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.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/element/attributes/name.yml) ```csharp // C# // TODO C# sample @@ -57,8 +67,10 @@ find_element(:accessibility_id, 'SomeAccessibilityID').tag_name ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -71,6 +83,7 @@ find_element(:accessibility_id, 'SomeAccessibilityID').tag_name | 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/element/attributes/name.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -85,10 +98,12 @@ find_element(:accessibility_id, 'SomeAccessibilityID').tag_name ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) `GET /wd/hub/session/:session_id/elements/:element_id/name` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) |name|description| |----|-----------| @@ -96,14 +111,17 @@ find_element(:accessibility_id, 'SomeAccessibilityID').tag_name |element_id|ID of the element to get the name from| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) The tag name of the element (`string`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/name.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-element-tag-name) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidname) diff --git a/docs/en/commands/element/attributes/page-index.md b/docs/en/commands/element/attributes/page-index.md index 2f17d76e4..d3df37c37 100644 --- a/docs/en/commands/element/attributes/page-index.md +++ b/docs/en/commands/element/attributes/page-index.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/element/attributes/page-index.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) # Get Tag Name Get an element's tag name +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) ```java // Java // TODO Java sample ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) ```python # Python // TODO Python sample ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) ```javascript // Javascript // webdriver.io example @@ -24,26 +29,31 @@ Get an element's tag name +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) // wd example // TODO javascript_wd sample ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) ```ruby # Ruby # ruby_lib example // TODO Ruby sample +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) # Not supported ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.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/element/attributes/page-index.yml) ```csharp // C# // TODO C# sample @@ -53,8 +63,10 @@ Get an element's tag name ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -67,6 +79,7 @@ Get an element's tag name | 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/element/attributes/page-index.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -81,10 +94,12 @@ Get an element's tag name ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) `GET /wd/hub/session/:session_id/element/:element_id/pageIndex` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) |name|description| |----|-----------| @@ -92,13 +107,16 @@ Get an element's tag name |element_id|ID of the element to get the name from| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) The tag name of the element (`string`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/page-index.yml) * [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L330) diff --git a/docs/en/commands/element/attributes/rect.md b/docs/en/commands/element/attributes/rect.md index 942f629e8..7c3fc5317 100644 --- a/docs/en/commands/element/attributes/rect.md +++ b/docs/en/commands/element/attributes/rect.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/element/attributes/rect.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) # Get Element Rect Gets dimensions and coordinates of an element +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) ```java // Java List element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,10 +15,12 @@ Rectangle rect = element.getRect(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) ```python # Not supported ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) ```javascript // Javascript // webdriver.io example @@ -23,12 +28,14 @@ let rect = driver.elementIdRect("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let rect = await element.getRect(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) ```ruby # Ruby # ruby_lib example @@ -36,18 +43,21 @@ element = find_element :accessibility_id, "SomeAccessibilityID" element.rect +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) # ruby_lib_core example element = @driver.find_element :accessibility_id, "SomeAccessibilityID" element.rect ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.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/element/attributes/rect.yml) ```csharp // C# // TODO C# sample @@ -57,8 +67,10 @@ element.rect ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -71,6 +83,7 @@ element.rect | 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/element/attributes/rect.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -85,10 +98,12 @@ element.rect ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) `GET /wd/hub/session/:session_id/elements/:element_id/rect` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) |name|description| |----|-----------| @@ -96,10 +111,12 @@ element.rect |element_id|ID of the element to get the rect of| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) |name|type|description| |----|----|-----------| @@ -109,5 +126,6 @@ None | weight | `number` | Width of the bounding rectangle | ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/rect.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-element-rect) diff --git a/docs/en/commands/element/attributes/replace-value.md b/docs/en/commands/element/attributes/replace-value.md index 8dcd4f6d9..e2a9402bf 100644 --- a/docs/en/commands/element/attributes/replace-value.md +++ b/docs/en/commands/element/attributes/replace-value.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/element/attributes/replace-value.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) # Replace the value Replace the value to element directly +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) ```java // Java // TODO Java sample ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) ```python # Python // TODO: Python example ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) ```javascript // Javascript // webdriver.io example @@ -24,11 +29,13 @@ Replace the value to element directly +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) // wd example // TODO JavaScript sample ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) ```ruby # Ruby # ruby_lib example @@ -36,18 +43,21 @@ element = find_element :accessibility_id, "SomeAccessibilityID" replace_value element, 'some' +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) # ruby_lib_core example element = @driver.find_element :accessibility_id, "SomeAccessibilityID" @driver.replace_value element, 'some' ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.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/element/attributes/replace-value.yml) ```csharp // C# // TODO C# sample @@ -55,14 +65,17 @@ element = @driver.find_element :accessibility_id, "SomeAccessibilityID" ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) ## Description Replace the value to element directly. ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -75,6 +88,7 @@ Replace the value to element directly. | 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/element/attributes/replace-value.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -89,10 +103,12 @@ Replace the value to element directly. ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) `POST /wd/hub/session/:session_id/appium/element/:element_id/replace_value` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) |name|description| |----|-----------| @@ -100,15 +116,18 @@ Replace the value to element directly. |element_id|ID of the element to get the text from| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) |name|type|description| |----|----|-----------| | value | `array` | The sequence of keys to type. An array must be provided. The server should flatten the array items to a single string to be typed. | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/replace-value.yml) * [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L550) diff --git a/docs/en/commands/element/attributes/selected.md b/docs/en/commands/element/attributes/selected.md index 5d9573e62..824262b9a 100644 --- a/docs/en/commands/element/attributes/selected.md +++ b/docs/en/commands/element/attributes/selected.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/element/attributes/selected.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) # Is Element Selected Determine if a form or form-like element (checkbox, select, etc...) is selected +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) ```java // Java MobileElement element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ boolean isSelected = element.isSelected(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) ```python # Python self.driver.find_element_by_accessibility_id('SomeAccessibilityID').is_selected() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) ```javascript // Javascript // webdriver.io example @@ -25,29 +30,34 @@ let isSelected = driver.isSelected("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let isSelected = await element.isSelected(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, "SomeAccessibilityID").selected? +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, "SomeAccessibilityID").selected? ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.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/element/attributes/selected.yml) ```csharp // C# // TODO C# sample @@ -57,8 +67,10 @@ find_element(:accessibility_id, "SomeAccessibilityID").selected? ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -71,6 +83,7 @@ find_element(:accessibility_id, "SomeAccessibilityID").selected? | 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/element/attributes/selected.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -85,10 +98,12 @@ find_element(:accessibility_id, "SomeAccessibilityID").selected? ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) `GET /wd/hub/session/:session_id/element/:element_id/selected` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) |name|description| |----|-----------| @@ -96,14 +111,17 @@ find_element(:accessibility_id, "SomeAccessibilityID").selected? |element_id|ID of the element to check if it is selected| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) Whether the element is selected (`boolean`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/selected.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-is-element-selected) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidselected) diff --git a/docs/en/commands/element/attributes/size.md b/docs/en/commands/element/attributes/size.md index 05a588943..c2cb5d4cc 100644 --- a/docs/en/commands/element/attributes/size.md +++ b/docs/en/commands/element/attributes/size.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/element/attributes/size.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) # Get Element Size Determine an element's size in pixels +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) ```java // Java List element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ Dimension elementSize = element.getSize(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) ```python # Python size = self.driver.find_element_by_accessibility_id('SomeAccessibilityID').size ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) ```javascript // Javascript // webdriver.io example @@ -25,23 +30,27 @@ let size = driver.getElementSize("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let size = await element.getSize(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, 'SomeAccessibilityID').size +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, 'SomeAccessibilityID').size ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) ```php # PHP $el = $this->byAccessibilityId('SomeAccessibilityID'); @@ -49,6 +58,7 @@ $size = $el->size(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) ```csharp // C# // TODO C# sample @@ -56,13 +66,16 @@ $size = $el->size(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) ## Description The size will be returned as an object with width and height properties. ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -75,6 +88,7 @@ The size will be returned as an object with width and height properties. | 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/element/attributes/size.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -89,10 +103,12 @@ The size will be returned as an object with width and height properties. ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) `GET /wd/hub/session/:session_id/elements/:element_id/size` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) |name|description| |----|-----------| @@ -100,10 +116,12 @@ The size will be returned as an object with width and height properties. |element_id|ID of the element to get the size of| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) |name|type|description| |----|----|-----------| @@ -111,5 +129,6 @@ None | height | `number` | Height of the element | ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/size.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidsize) diff --git a/docs/en/commands/element/attributes/text.md b/docs/en/commands/element/attributes/text.md index f8fb4000e..4b4843f0d 100644 --- a/docs/en/commands/element/attributes/text.md +++ b/docs/en/commands/element/attributes/text.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/element/attributes/text.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) # Get Element Text Returns visible text for element +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) ```java // Java MobileElement element = (MobileElement) driver.findElementByClassName("SomeClassName"); @@ -12,6 +15,7 @@ String elText = element.getText(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) ```python # Python el = self.driver.find_element_by_accessibility_id('SomeAccessibilityID') @@ -19,6 +23,7 @@ text = el.text ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) ```javascript // Javascript // webdriver.io example @@ -26,12 +31,14 @@ driver.getText("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); await element.text(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) ```ruby # Ruby # ruby_lib example @@ -39,12 +46,14 @@ element = find_element :accessibility_id, "SomeAccessibilityID" element.text +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) # ruby_lib_core example element = @driver.find_element :accessibility_id, "SomeAccessibilityID" element.text ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) ```php # PHP $el = $this->byAccessibilityId('SomeAccessibilityID'); @@ -52,6 +61,7 @@ $text = $el->text(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) ```csharp // C# // TODO C# sample @@ -59,14 +69,17 @@ $text = $el->text(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) ## Description Returns the visible text for the element. ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -79,6 +92,7 @@ Returns the visible text for the element. | 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/element/attributes/text.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -93,10 +107,12 @@ Returns the visible text for the element. ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) `GET /wd/hub/session/:session_id/element/:element_id/text` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) |name|description| |----|-----------| @@ -104,14 +120,17 @@ Returns the visible text for the element. |element_id|ID of the element to get the text from| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/text.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-element-text) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidtext) diff --git a/docs/en/commands/element/find-element.md b/docs/en/commands/element/find-element.md index 23cd3325a..a5f4e5990 100644 --- a/docs/en/commands/element/find-element.md +++ b/docs/en/commands/element/find-element.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/element/find-element.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) # Find Element Search for an element on the page +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) ```java // Java MobileElement elementOne = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ MobileElement elementTwo = (MobileElement) driver.findElementByClassName("SomeCl ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) ```python # Python el = self.driver.find_element_by_accessibility_id('SomeAccessibilityID') ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) ```javascript // Javascript // webdriver.io example @@ -25,29 +30,34 @@ driver.element("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) // wd example let elementOne = await driver.elementByAccessibilityId("SomeAccessibilityID"); let elementTwo = await driver.element("id", "SomeID"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) ```ruby # Ruby # ruby_lib example find_element(:accessibility_id, 'SomeAccessibilityID') +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) # ruby_lib_core example @driver.find_element(:accessibility_id, 'SomeAccessibilityID') ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) ```php # PHP $el = $this->byAccessibilityId('SomeAccessibilityID'); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) ```csharp // C# // TODO C# sample @@ -55,14 +65,17 @@ $el = $this->byAccessibilityId('SomeAccessibilityID'); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) ## Description Get the first element that matches a [locator strategy](/docs/en/commands/element/find-elements.md#selector-strategies) ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -75,6 +88,7 @@ Get the first element that matches a [locator strategy](/docs/en/commands/elemen | 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/element/find-element.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -89,16 +103,19 @@ Get the first element that matches a [locator strategy](/docs/en/commands/elemen ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) `POST /wd/hub/session/:session_id/element` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.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/element/find-element.yml) |name|type|description| |----|----|-----------| @@ -106,10 +123,12 @@ Get the first element that matches a [locator strategy](/docs/en/commands/elemen | value | `string` | The search target | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) A JSON object for the located element (`object`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-element.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#find-element) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelement) diff --git a/docs/en/commands/element/find-elements.md b/docs/en/commands/element/find-elements.md index 2cd4ee63a..a32c23588 100644 --- a/docs/en/commands/element/find-elements.md +++ b/docs/en/commands/element/find-elements.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/element/find-elements.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) # Find Elements Search for multiple elements +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) ```java // Java List elementsOne = (MobileElement) driver.findElementsByAccessibilityId("SomeAccessibilityID"); @@ -12,12 +15,14 @@ List elementsTwo = (MobileElement) driver.findElementsByClassName ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) ```python # Python el = self.driver.find_elements_by_accessibility_id('SomeAccessibilityID') ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) ```javascript // Javascript // webdriver.io example @@ -25,35 +30,41 @@ driver.elements("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) // wd example let elementsOne = await driver.elementsByAccessibilityId("SomeAccessibilityID"); let elementsTwo = await driver.elements("id", "SomeID"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) ```ruby # Ruby # ruby_lib example find_elements(:accessibility_id, "~SomeAccessibilityID") +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) # ruby_lib_core example @driver.find_elements(:accessibility_id, "~SomeAccessibilityID") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) ```php # PHP $els = $this->elements($this->using('accessibility id')->value('SomeAccessibilityID')); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) ```csharp // C# // TODO C# sample ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) ## Selector Strategies |Strategy|Description| |--------|-----------| @@ -67,14 +78,17 @@ $els = $this->elements($this->using('accessibility id')->value('SomeAccessibilit |Android View Tag (Espresso only)|Locate an element by its [view tag](https://developer.android.com/reference/android/support/test/espresso/matcher/ViewMatchers.html#withTagValue(org.hamcrest.Matcher%3Cjava.lang.Object%3E))| |IOS UIAutomation|When automating an iOS application, Apple’s [Instruments](/docs/en/drivers/ios-uiautomation.md) framework can be used to find elements| +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) ## Description Get a list of elements that match the [locator selector](/docs/en/writing-running-appium/finding-elements.md). ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -87,6 +101,7 @@ Get a list of elements that match the [locator selector](/docs/en/writing-runnin | 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/element/find-elements.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -101,16 +116,19 @@ Get a list of elements that match the [locator selector](/docs/en/writing-runnin ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) `POST /wd/hub/session/:session_id/elements` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.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/element/find-elements.yml) |name|type|description| |----|----|-----------| @@ -118,10 +136,12 @@ Get a list of elements that match the [locator selector](/docs/en/writing-runnin | value | `string` | The search target | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) A list of of JSON objects for the located elements (`Array`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/find-elements.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-find-elements) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelements) diff --git a/docs/en/commands/element/other/README.md b/docs/en/commands/element/other/README.md index 52a81c5a3..da34ca728 100644 --- a/docs/en/commands/element/other/README.md +++ b/docs/en/commands/element/other/README.md @@ -3,12 +3,15 @@ ## Appium API Documentation ### /docs/en/commands/element/other + [//]: # (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/element/other/active.md b/docs/en/commands/element/other/active.md index c828fd74a..9f8055fe3 100644 --- a/docs/en/commands/element/other/active.md +++ b/docs/en/commands/element/other/active.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/element/other/active.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) # Get Active Element Gets the active element of the current session +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) ```java // Java WebElement currentElement = driver.switchTo().activeElement(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) ```python # Python element = driver.switch_to.active_element ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.elementActive(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) // wd example let element = await driver.active(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) ```ruby # Ruby # ruby_lib example switch_to.active_element +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) # ruby_lib_core example @driver.switch_to.active_element ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) ```php # PHP // TODO PHP example ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) ```csharp // C# // TODO C# example @@ -55,8 +65,10 @@ switch_to.active_element ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ switch_to.active_element | 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/element/other/active.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,22 +96,27 @@ switch_to.active_element ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) `POST /wd/hub/session/:session_id/element/active` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) None ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) A JSON object for the located element (`object`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/active.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#get-active-element) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementactive) diff --git a/docs/en/commands/element/other/equals-element.md b/docs/en/commands/element/other/equals-element.md index 315cfb401..191ca9daa 100644 --- a/docs/en/commands/element/other/equals-element.md +++ b/docs/en/commands/element/other/equals-element.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/element/other/equals-element.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) # Are Elements Equal Test if two element IDs refer to the same element +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) ```java // Java // Overrides the Java Object .equals method @@ -14,12 +17,14 @@ boolean isEqual = elementOne.equals(elementTwo); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) ```python # Python # TODO Python sample ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) ```javascript // Javascript // webdriver.io example @@ -27,6 +32,7 @@ boolean isEqual = elementOne.equals(elementTwo); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) // wd example let elementOne = await driver.elementByClassName("someClass"); let elementTwo = await driver.elementByClassName("someOtherClass"); @@ -34,6 +40,7 @@ let isEqual = await elementOne.equalsElement(elementTwo); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) ```ruby # Ruby # ruby_lib example @@ -42,6 +49,7 @@ element2 = find_element :class_name, "someOtherClass" element1 == element2 +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) # ruby_lib_core example element1 = @driver.find_element :class_name, "someClass" element2 = @driver.find_element :class_name, "someOtherClass" @@ -49,12 +57,14 @@ element1 == element2 ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.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/element/other/equals-element.yml) ```csharp // C# // TODO C# sample @@ -64,8 +74,10 @@ element1 == element2 ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -78,6 +90,7 @@ element1 == element2 | 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/element/other/equals-element.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -92,10 +105,12 @@ element1 == element2 ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) `GET /wd/hub/session/:session_id/element/:element_id/equals/:other_element_id` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) |name|description| |----|-----------| @@ -104,13 +119,16 @@ element1 == element2 |element_id|ID of the other element to check if they're equal| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) Whether the two ID's refer to the same element (`boolean`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/equals-element.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidequalsother) diff --git a/docs/en/commands/element/other/submit.md b/docs/en/commands/element/other/submit.md index 87ed691e7..156348968 100644 --- a/docs/en/commands/element/other/submit.md +++ b/docs/en/commands/element/other/submit.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/element/other/submit.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) # Submit Form Submit a FORM element +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) ```java // Java MobileElement element = (MobileElement) driver.findElementByClassName("SomeClassName"); @@ -12,6 +15,7 @@ element.submit(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) ```python # Python el = self.driver.find_element_by_accessibility_id('SomeAccessibilityID') @@ -19,6 +23,7 @@ el.submit(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) ```javascript // Javascript // webdriver.io example @@ -26,12 +31,14 @@ driver.submitForm("~SomeAccessibilityId"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); await element.submit(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) ```ruby # Ruby # ruby_lib example @@ -39,18 +46,21 @@ element = find_element :class_name, "someClass" element.submit element +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) # ruby_lib_core example element = @driver.find_element :class_name, "someClass" element.submit element ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.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/element/other/submit.yml) ```csharp // C# // TODO C# sample @@ -58,14 +68,17 @@ element.submit element ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) ## Description The submit command may also be applied to any element that is a descendant of a FORM element (Web only) ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -78,6 +91,7 @@ The submit command may also be applied to any element that is a descendant of a | 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/element/other/submit.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -92,10 +106,12 @@ The submit command may also be applied to any element that is a descendant of a ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) `POST /wd/hub/session/:session_id/element/:element_id/submit` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) |name|description| |----|-----------| @@ -103,13 +119,16 @@ The submit command may also be applied to any element that is a descendant of a |element_id|ID of the element to submit| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/other/submit.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidsubmit) diff --git a/docs/en/commands/interactions/README.md b/docs/en/commands/interactions/README.md index 6012ed71f..2f45be6df 100644 --- a/docs/en/commands/interactions/README.md +++ b/docs/en/commands/interactions/README.md @@ -3,9 +3,11 @@ ## Appium API Documentation ### /docs/en/commands/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/interactions/actions.md b/docs/en/commands/interactions/actions.md index f0716158e..ec140f4e3 100644 --- a/docs/en/commands/interactions/actions.md +++ b/docs/en/commands/interactions/actions.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/interactions/actions.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) # Actions Perform a chain or multiple chains of keyboard and pointer (touch, mouse, stylus) actions +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) ```java // Java WebElement source = (MobileElement) driver.findElementsByAccessibilityId("SomeAccessibilityID"); WebElement target = (MobileElement) driver.findElementsByAccessibilityId("SomeOtherAccessibilityID"); Point source = dragMe.getCenter(); Point target = driver.findElementByAccessibilityId("dropzone").getCenter(); PointerInput finger = new PointerInput(PointerInput.Kind.TOUCH, "finger"); Sequence dragNDrop = new Sequence(finger, 1); dragNDrop.addAction(finger.createPointerMove(Duration.ofMillis(0), PointerInput.Origin.viewport(), source.x, source.y)); dragNDrop.addAction(finger.createPointerDown(PointerInput.MouseButton.LEFT.asArg())); dragNDrop.addAction(finger.createPointerMove(Duration.ofMillis(700), PointerInput.Origin.viewport(),target.x, target.y)); dragNDrop.addAction(finger.createPointerUp(PointerInput.MouseButton.LEFT.asArg())); driver.perform(Arrays.asList(dragNDrop)); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) ```python # Python element = driver.find_element_by_accessibility_id("elId") @@ -21,6 +25,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) ```javascript // Javascript // webdriver.io example @@ -55,6 +60,7 @@ browser.actions(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) // wd example // Performs a 'pinch-and-zoom' var actions = new wd.W3CActions(driver); @@ -77,6 +83,7 @@ await driver.releaseW3CActions(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) ```ruby # Ruby # ruby_lib example @@ -107,6 +114,7 @@ f2.create_pointer_up(:left) perform_actions [f1, f2] +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) # ruby_lib_core example # Send keys to an element # Build Single action chain @@ -136,12 +144,14 @@ f2.create_pointer_up(:left) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) ```php # PHP // TODO ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) ```csharp // C# // TODO @@ -149,6 +159,7 @@ f2.create_pointer_up(:left) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) ## Description * input source: Represents an input device (pointer or key) that a series of actions are dispatched to. The input source has a unique ID. @@ -160,8 +171,10 @@ is the 0-indexed action, the second 'tick' is the 1-indexed action, etc.... All ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -174,6 +187,7 @@ is the 0-indexed action, the second 'tick' is the 1-indexed action, etc.... All | 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/interactions/actions.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -188,16 +202,19 @@ is the 0-indexed action, the second 'tick' is the 1-indexed action, etc.... All ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) `POST /wd/hub/session/:sessionId/actions` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.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/interactions/actions.yml) |name|type|description| |----|----|-----------| @@ -218,9 +235,11 @@ is the 0-indexed action, the second 'tick' is the 1-indexed action, etc.... All | actions[$INDEX].actions[$INDEX].y | `number` | Y coordinate of pointer move event | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/actions.yml) * [W3C Specification](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/interactions/Actions.html) diff --git a/docs/en/commands/interactions/mouse/README.md b/docs/en/commands/interactions/mouse/README.md index c5f9e43be..8e02c4270 100644 --- a/docs/en/commands/interactions/mouse/README.md +++ b/docs/en/commands/interactions/mouse/README.md @@ -3,9 +3,11 @@ ## Appium API Documentation ### /docs/en/commands/interactions/mouse + [//]: # (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/interactions/mouse/button-down.md b/docs/en/commands/interactions/mouse/button-down.md index 009ff9122..34ee75363 100644 --- a/docs/en/commands/interactions/mouse/button-down.md +++ b/docs/en/commands/interactions/mouse/button-down.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/interactions/mouse/button-down.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) # Button Down Click and hold the left mouse button at the current mouse coordinates +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) ```java // Java Actions action = new Actions(driver); @@ -14,6 +17,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) ```python # Python actions = ActionChains(driver) @@ -23,6 +27,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) ```javascript // Javascript // webdriver.io example @@ -31,29 +36,34 @@ driver.moveTo(element) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) // wd example await driver.moveTo(element); await driver.buttonDown(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) ```ruby # Ruby # ruby_lib example action.move_to(element).click_and_hold.perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) # ruby_lib_core example @driver.action.move_to(element).click_and_hold.perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.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/interactions/mouse/button-down.yml) ```csharp // C# // TODO C# sample @@ -61,14 +71,17 @@ action.move_to(element).click_and_hold.perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) ## Description Note that the next mouse-related command that should follow is buttonup . Any other mouse command (such as click or another call to buttondown) will yield undefined behavior ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -81,6 +94,7 @@ Note that the next mouse-related command that should follow is buttonup . Any ot | 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/interactions/mouse/button-down.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -95,25 +109,30 @@ Note that the next mouse-related command that should follow is buttonup . Any ot ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) `POST /session/:session_id/buttondown` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.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/interactions/mouse/button-down.yml) |name|type|description| |----|----|-----------| | button | `number` | Which button, {LEFT = 0, MIDDLE = 1 , RIGHT = 2}. Defaults to the left mouse button if not specified | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-down.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidbuttondown) diff --git a/docs/en/commands/interactions/mouse/button-up.md b/docs/en/commands/interactions/mouse/button-up.md index b1538a7b2..d6c7be9c9 100644 --- a/docs/en/commands/interactions/mouse/button-up.md +++ b/docs/en/commands/interactions/mouse/button-up.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/interactions/mouse/button-up.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) # Button Up Releases the mouse button previously held +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) ```java // Java Actions action = new Actions(driver); @@ -16,6 +19,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) ```python # Python actions = ActionChains(driver) @@ -27,6 +31,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) ```javascript // Javascript // webdriver.io example @@ -37,6 +42,7 @@ driver.moveTo(element) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) // wd example await driver.moveTo(element); await driver.buttonDown(); @@ -45,23 +51,27 @@ await driver.buttonUp(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) ```ruby # Ruby # ruby_lib example action.click_and_hold(el).move_to(el, 10, 10).release.perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) # ruby_lib_core example @driver.action.click_and_hold(el).move_to(el, 10, 10).release.perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.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/interactions/mouse/button-up.yml) ```csharp // C# // TODO C# sample @@ -69,14 +79,17 @@ action.click_and_hold(el).move_to(el, 10, 10).release.perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) ## Description Must be called once for every buttondown command issued. See the note in click and buttondown about implications of out-of-order commands. ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -89,6 +102,7 @@ Must be called once for every buttondown command issued. See the note in click a | 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/interactions/mouse/button-up.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -103,25 +117,30 @@ Must be called once for every buttondown command issued. See the note in click a ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) `POST /session/:session_id/buttonup` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.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/interactions/mouse/button-up.yml) |name|type|description| |----|----|-----------| | button | `number` | Which button, {LEFT = 0, MIDDLE = 1 , RIGHT = 2}. Defaults to the left mouse button if not specified | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/button-up.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidbuttonup) diff --git a/docs/en/commands/interactions/mouse/click.md b/docs/en/commands/interactions/mouse/click.md index 39de7c2c5..4659fa56e 100644 --- a/docs/en/commands/interactions/mouse/click.md +++ b/docs/en/commands/interactions/mouse/click.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/interactions/mouse/click.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) # Click Click any mouse button at the current mouse coordinates +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) ```java // Java Actions action = new Actions(driver); @@ -14,6 +17,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) ```python # Python actions = ActionChains(driver) @@ -23,6 +27,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) ```javascript // Javascript // webdriver.io example @@ -31,29 +36,34 @@ driver.moveTo(element) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) // wd example await driver.moveTo(element); await driver.click(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) ```ruby # Ruby # ruby_lib example action.move_to(element).click.perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) # ruby_lib_core example @driver.action.move_to(element).click.perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.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/interactions/mouse/click.yml) ```csharp // C# Actions action = new Actions(driver); @@ -66,8 +76,10 @@ action.Perform(); ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -80,6 +92,7 @@ action.Perform(); | 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/interactions/mouse/click.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -94,25 +107,30 @@ action.Perform(); ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) `POST /session/:session_id/click` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.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/interactions/mouse/click.yml) |name|type|description| |----|----|-----------| | button | `number` | Which button, {LEFT = 0, MIDDLE = 1 , RIGHT = 2}. Defaults to the left mouse button if not specified | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/click.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidclick) diff --git a/docs/en/commands/interactions/mouse/doubleclick.md b/docs/en/commands/interactions/mouse/doubleclick.md index 810c28abc..0ec12ecbb 100644 --- a/docs/en/commands/interactions/mouse/doubleclick.md +++ b/docs/en/commands/interactions/mouse/doubleclick.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/interactions/mouse/doubleclick.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) # Click Double-clicks at the current mouse coordinates (set by moveto). +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) ```java // Java Actions action = new Actions(driver); @@ -14,6 +17,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) ```python # Python actions = ActionChains(driver) @@ -23,6 +27,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) ```javascript // Javascript // webdriver.io example @@ -31,29 +36,34 @@ driver.moveTo(element) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) // wd example await driver.moveTo(element); await driver.doubleclick(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) ```ruby # Ruby # ruby_lib example action.move_to(element).double_click.perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) # ruby_lib_core example @driver.action.move_to(element).double_click.perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.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/interactions/mouse/doubleclick.yml) ```csharp // C# // TODO C# sample @@ -63,8 +73,10 @@ action.move_to(element).double_click.perform ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -77,6 +89,7 @@ action.move_to(element).double_click.perform | 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/interactions/mouse/doubleclick.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -91,23 +104,28 @@ action.move_to(element).double_click.perform ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) `POST /session/:session_id/doubledoubleClick` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.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/interactions/mouse/doubleclick.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/doubleclick.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessioniddoubledoubleClick) diff --git a/docs/en/commands/interactions/mouse/moveto.md b/docs/en/commands/interactions/mouse/moveto.md index 5dff949b2..d1a79a6cb 100644 --- a/docs/en/commands/interactions/mouse/moveto.md +++ b/docs/en/commands/interactions/mouse/moveto.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/interactions/mouse/moveto.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) # Move Mouse To Move the mouse by an offset of the specificed element +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) ```java // Java Actions action = new Actions(driver); @@ -13,6 +16,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) ```python # Python actions = ActionChains(driver) @@ -21,6 +25,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) ```javascript // Javascript // webdriver.io example @@ -28,11 +33,13 @@ driver.moveTo(element, 10, 10); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) // wd example await driver.moveTo(element, 10, 10); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) ```ruby # Ruby # ruby_lib example @@ -40,18 +47,21 @@ mouse.move_to(element) mouse.move_to(element, 5, 5) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) # ruby_lib_core example @driver.mouse.move_to(element) @driver.mouse.move_to(element, 5, 5) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.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/interactions/mouse/moveto.yml) ```csharp // C# Actions action = new Actions(driver); @@ -61,14 +71,17 @@ action.Perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) ## Description If no element is specified, the move is relative to the current mouse cursor. If an element is provided but no offset, the mouse will be moved to the center of the element. If the element is not visible, it will be scrolled into view. ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -81,6 +94,7 @@ If no element is specified, the move is relative to the current mouse cursor. If | 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/interactions/mouse/moveto.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -95,16 +109,19 @@ If no element is specified, the move is relative to the current mouse cursor. If ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) `POST /session/:session_id/moveto` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.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/interactions/mouse/moveto.yml) |name|type|description| |----|----|-----------| @@ -113,10 +130,12 @@ If no element is specified, the move is relative to the current mouse cursor. If | yoffset | `number` | Y offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/mouse/moveto.yml) * [W3C Specification](https://drafts.csswg.org/cssom-view/#dom-window-moveto) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidmoveto) diff --git a/docs/en/commands/interactions/touch/README.md b/docs/en/commands/interactions/touch/README.md index f8860bce9..44dd06cc6 100644 --- a/docs/en/commands/interactions/touch/README.md +++ b/docs/en/commands/interactions/touch/README.md @@ -3,9 +3,11 @@ ## Appium API Documentation ### /docs/en/commands/interactions/touch + [//]: # (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/interactions/touch/double-tap.md b/docs/en/commands/interactions/touch/double-tap.md index a88e8670a..08dd8c06d 100644 --- a/docs/en/commands/interactions/touch/double-tap.md +++ b/docs/en/commands/interactions/touch/double-tap.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/interactions/touch/double-tap.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) # Double Tap Double tap on the touch screen using finger motion events +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) ```java // Java TouchActions action = new TouchActions(driver); @@ -13,6 +16,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) ```python # Python from appium.webdriver.common.touch_action import TouchAction @@ -23,10 +27,12 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) ```javascript // Not supported +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) // wd example // Using tapElement method await driver.tapElement(elementOne); @@ -38,23 +44,27 @@ await action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) ```ruby # Ruby # ruby_lib example touch_action.double_tap(element).perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) # ruby_lib_core example @driver.touch_action.double_tap(element).perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.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/interactions/touch/double-tap.yml) ```csharp // C# // TODO C# sample @@ -64,8 +74,10 @@ touch_action.double_tap(element).perform ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -78,6 +90,7 @@ touch_action.double_tap(element).perform | 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/interactions/touch/double-tap.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -92,25 +105,30 @@ touch_action.double_tap(element).perform ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) `POST /session/:session_id/touch/doubleclick` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.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/interactions/touch/double-tap.yml) |name|type|description| |----|----|-----------| | element | `number` | ID of the element to double tap on | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/double-tap.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchdoubleclick) diff --git a/docs/en/commands/interactions/touch/flick.md b/docs/en/commands/interactions/touch/flick.md index b5daa44cf..1be020983 100644 --- a/docs/en/commands/interactions/touch/flick.md +++ b/docs/en/commands/interactions/touch/flick.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/interactions/touch/flick.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) # Flick Flick on the touch screen using finger motion events +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) ```java // Java TouchActions action = new TouchActions(driver); @@ -13,6 +16,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) ```python # Python from appium.webdriver.common.touch_action import TouchAction @@ -23,6 +27,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) ```javascript // Javascript // webdriver.io example @@ -30,28 +35,33 @@ driver.touchFlick('', 1, 10, 10); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) // wd example await element.flick(1, 10, 10); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) ```ruby # Ruby # ruby_lib example touch_action.flick(element, 1, 10, 10).perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) # ruby_lib_core example @driver.touch_action.flick(element, 1, 10, 10).perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.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/interactions/touch/flick.yml) ```csharp // C# // TODO C# sample @@ -61,8 +71,10 @@ touch_action.flick(element, 1, 10, 10).perform ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -75,6 +87,7 @@ touch_action.flick(element, 1, 10, 10).perform | 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/interactions/touch/flick.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -89,16 +102,19 @@ touch_action.flick(element, 1, 10, 10).perform ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) `POST /session/:session_id/touch/flick` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.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/interactions/touch/flick.yml) |name|type|description| |----|----|-----------| @@ -108,9 +124,11 @@ touch_action.flick(element, 1, 10, 10).perform | speed | `number` | The speed in pixels per seconds | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchflick) diff --git a/docs/en/commands/interactions/touch/long-press.md b/docs/en/commands/interactions/touch/long-press.md index 128aacded..f18a57c0f 100644 --- a/docs/en/commands/interactions/touch/long-press.md +++ b/docs/en/commands/interactions/touch/long-press.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/interactions/touch/long-press.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) # Long Tap Long press on the touch screen using finger motion events +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) ```java // Java TouchActions action = new TouchActions(driver); @@ -13,6 +16,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) ```python # Python from appium.webdriver.common.touch_action import TouchAction @@ -23,6 +27,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) ```javascript // Javascript // webdriver.io example @@ -35,6 +40,7 @@ driver.touchPerform({ +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) // wd example // Using touch actions let action = new wd.TouchAction(); @@ -43,23 +49,27 @@ await action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) ```ruby # Ruby # ruby_lib example touch_action.long_press(element).perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) # ruby_lib_core example @driver.touch_action.long_press(element).perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.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/interactions/touch/long-press.yml) ```csharp // C# // TODO C# sample @@ -69,8 +79,10 @@ touch_action.long_press(element).perform ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -83,6 +95,7 @@ touch_action.long_press(element).perform | 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/interactions/touch/long-press.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -97,25 +110,30 @@ touch_action.long_press(element).perform ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) `POST /session/:session_id/touch/longclick` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.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/interactions/touch/long-press.yml) |name|type|description| |----|----|-----------| | element | `number` | ID of the element to double tap on | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/long-press.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchlongclick) diff --git a/docs/en/commands/interactions/touch/move.md b/docs/en/commands/interactions/touch/move.md index 78a79ac21..3a3013d11 100644 --- a/docs/en/commands/interactions/touch/move.md +++ b/docs/en/commands/interactions/touch/move.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/interactions/touch/move.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) # Move Finger move on the screen +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) ```java // Java TouchActions action = new TouchActions(driver); @@ -14,6 +17,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) ```python # Python from appium.webdriver.common.touch_action import TouchAction @@ -25,6 +29,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) ```javascript // Javascript // webdriver.io example @@ -36,6 +41,7 @@ driver.touchMultiPerform([ +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) // wd example let action = new wd.TouchAction(); action.press({x: 10, y: 10}) @@ -45,23 +51,27 @@ await action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) ```ruby # Ruby # ruby_lib example touch_action.down(element).move().perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) # ruby_lib_core example @driver.touch_action.down(element).move().perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.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/interactions/touch/move.yml) ```csharp // C# // TODO C# sample @@ -69,14 +79,17 @@ touch_action.down(element).move().perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) ## Description As of Appium 1.8.0 all move actions take coordinates that are absolute. ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -89,6 +102,7 @@ As of Appium 1.8.0 all move actions take coordinates that are absolute. | 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/interactions/touch/move.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -103,16 +117,19 @@ As of Appium 1.8.0 all move actions take coordinates that are absolute. ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) `POST /session/:session_id/touch/move` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.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/interactions/touch/move.yml) |name|type|description| |----|----|-----------| @@ -120,9 +137,11 @@ As of Appium 1.8.0 all move actions take coordinates that are absolute. | y | `number` | Y coordinate on the screen | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/move.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchmove) diff --git a/docs/en/commands/interactions/touch/multi-touch-perform.md b/docs/en/commands/interactions/touch/multi-touch-perform.md index 084c33b6a..fcc24f3fd 100644 --- a/docs/en/commands/interactions/touch/multi-touch-perform.md +++ b/docs/en/commands/interactions/touch/multi-touch-perform.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/interactions/touch/multi-touch-perform.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) # Multi Touch Perform Perform a multi touch action sequence +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) ```java // Java TouchActions actionOne = new TouchAction(); @@ -22,6 +25,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) ```python # Python from appium.webdriver.common.touch_action import TouchAction @@ -43,6 +47,7 @@ ma.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) ```javascript // Javascript // webdriver.io example @@ -54,6 +59,7 @@ driver.touchMultiPerform([ +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) // wd example let action = new wd.MultiTouchAction(); action.press({x: 10, y: 10}); @@ -63,23 +69,27 @@ await action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) ```ruby # Ruby # ruby_lib example multi_touch.down(element).move_to(10, 100).up(50, 50).perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) # ruby_lib_core example @driver.multi_touch.down(element).move_to(10, 100).up(50, 50).perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.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/interactions/touch/multi-touch-perform.yml) ```csharp // C# // TODO C# sample @@ -89,8 +99,10 @@ multi_touch.down(element).move_to(10, 100).up(50, 50).perform ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -103,6 +115,7 @@ multi_touch.down(element).move_to(10, 100).up(50, 50).perform | 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/interactions/touch/multi-touch-perform.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -117,16 +130,19 @@ multi_touch.down(element).move_to(10, 100).up(50, 50).perform ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) `POST /session/:session_id/touch/multi/perform` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.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/interactions/touch/multi-touch-perform.yml) |name|type|description| |----|----|-----------| @@ -138,9 +154,11 @@ multi_touch.down(element).move_to(10, 100).up(50, 50).perform | opts.count | `number` | Tap count | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/multi-touch-perform.yml) * [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L340) diff --git a/docs/en/commands/interactions/touch/scroll.md b/docs/en/commands/interactions/touch/scroll.md index 90d69086f..7c597dc46 100644 --- a/docs/en/commands/interactions/touch/scroll.md +++ b/docs/en/commands/interactions/touch/scroll.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/interactions/touch/scroll.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) # Scroll Scroll on the touch screen using finger based motion events +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) ```java // Java TouchActions action = new TouchActions(driver); @@ -13,6 +16,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) ```python # Python from appium.webdriver.common.touch_action import TouchAction @@ -24,6 +28,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) ```javascript // Javascript // webdriver.io example @@ -35,28 +40,33 @@ driver.touchScroll({ +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) // wd example await driver.scroll(10, 100); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) ```ruby # Ruby # ruby_lib example touch_action.scroll(element, 10, 100).perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) # ruby_lib_core example @driver.touch_action.scroll(element, 10, 100).perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.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/interactions/touch/scroll.yml) ```csharp // C# // TODO C# sample @@ -66,8 +76,10 @@ touch_action.scroll(element, 10, 100).perform ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -80,6 +92,7 @@ touch_action.scroll(element, 10, 100).perform | 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/interactions/touch/scroll.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -94,16 +107,19 @@ touch_action.scroll(element, 10, 100).perform ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) `POST /session/:session_id/touch/scroll` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.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/interactions/touch/scroll.yml) |name|type|description| |----|----|-----------| @@ -111,9 +127,11 @@ touch_action.scroll(element, 10, 100).perform | y | `number` | Y coordinate on the screen | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchscroll) diff --git a/docs/en/commands/interactions/touch/tap.md b/docs/en/commands/interactions/touch/tap.md index ab8501b71..2241150d4 100644 --- a/docs/en/commands/interactions/touch/tap.md +++ b/docs/en/commands/interactions/touch/tap.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/interactions/touch/tap.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) # Tap Single tap on the touch enabled device +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) ```java // Java TouchActions action = new TouchActions(driver); @@ -13,6 +16,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) ```python # Python from appium.webdriver.common.touch_action import TouchAction @@ -23,6 +27,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) ```javascript // Javascript // webdriver.io example @@ -35,6 +40,7 @@ driver.touchPerform({ +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) // wd example // Using tapElement method await driver.tapElement(elementOne); @@ -46,23 +52,27 @@ await action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) ```ruby # Ruby # ruby_lib example touch_action.single_tap(element).perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) # ruby_lib_core example @driver.touch_action.single_tap(element).perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.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/interactions/touch/tap.yml) ```csharp // C# // TODO C# sample @@ -72,8 +82,10 @@ touch_action.single_tap(element).perform ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -86,6 +98,7 @@ touch_action.single_tap(element).perform | 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/interactions/touch/tap.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -100,25 +113,30 @@ touch_action.single_tap(element).perform ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) `POST /session/:session_id/touch/click` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.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/interactions/touch/tap.yml) |name|type|description| |----|----|-----------| | element | `number` | ID of the element to double tap on | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/tap.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchclick) diff --git a/docs/en/commands/interactions/touch/touch-down.md b/docs/en/commands/interactions/touch/touch-down.md index dff6e4d72..15be5e886 100644 --- a/docs/en/commands/interactions/touch/touch-down.md +++ b/docs/en/commands/interactions/touch/touch-down.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/interactions/touch/touch-down.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) # Touch Down Finger down on the screen +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) ```java // Java TouchActions action = new TouchActions(driver); @@ -14,6 +17,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) ```python # Python from appium.webdriver.common.touch_action import TouchAction @@ -25,6 +29,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) ```javascript // Javascript // webdriver.io example @@ -36,6 +41,7 @@ driver.touchMultiPerform([ +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) // wd example // Using tapElement method await driver.tapElement(elementOne); @@ -48,23 +54,27 @@ await action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) ```ruby # Ruby # ruby_lib example touch_action.down(element).move().perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) # ruby_lib_core example @driver.touch_action.down(element).move().perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.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/interactions/touch/touch-down.yml) ```csharp // C# // TODO C# sample @@ -74,8 +84,10 @@ touch_action.down(element).move().perform ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -88,6 +100,7 @@ touch_action.down(element).move().perform | 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/interactions/touch/touch-down.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -102,16 +115,19 @@ touch_action.down(element).move().perform ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) `POST /session/:session_id/touch/down` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.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/interactions/touch/touch-down.yml) |name|type|description| |----|----|-----------| @@ -119,9 +135,11 @@ touch_action.down(element).move().perform | y | `number` | Y coordinate on the screen | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-down.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchdown) diff --git a/docs/en/commands/interactions/touch/touch-perform.md b/docs/en/commands/interactions/touch/touch-perform.md index 06f27dbf2..d4ae0c153 100644 --- a/docs/en/commands/interactions/touch/touch-perform.md +++ b/docs/en/commands/interactions/touch/touch-perform.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/interactions/touch/touch-perform.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) # Touch Perform Perform a touch action sequence +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) ```java // Java TouchAction action = new TouchAction(driver); @@ -15,6 +18,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) ```python # Python from appium.webdriver.common.touch_action import TouchAction @@ -27,6 +31,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) ```javascript // Javascript // webdriver.io example @@ -38,6 +43,7 @@ driver.touchPerform([ +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) // wd example let action = new wd.TouchAction(); action.press({x: 10, y: 10}); @@ -47,23 +53,27 @@ await action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) ```ruby # Ruby # ruby_lib example touch_action.down(element).move_to(10, 100).up(50, 50).perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) # ruby_lib_core example @driver.touch_action.down(element).move_to(10, 100).up(50, 50).perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.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/interactions/touch/touch-perform.yml) ```csharp // C# // TODO C# sample @@ -71,6 +81,7 @@ touch_action.down(element).move_to(10, 100).up(50, 50).perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) ## Description This functionality is only available from within a native context @@ -82,8 +93,10 @@ y coordinate, and then releasing. For it to work, there can't be a delay between ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -96,6 +109,7 @@ y coordinate, and then releasing. For it to work, there can't be a delay between | 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/interactions/touch/touch-perform.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -110,16 +124,19 @@ y coordinate, and then releasing. For it to work, there can't be a delay between ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) `POST /session/:session_id/touch/perform` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.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/interactions/touch/touch-perform.yml) |name|type|description| |----|----|-----------| @@ -131,9 +148,11 @@ y coordinate, and then releasing. For it to work, there can't be a delay between | opts.count | `number` | Tap count | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-perform.yml) * [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L337) diff --git a/docs/en/commands/interactions/touch/touch-up.md b/docs/en/commands/interactions/touch/touch-up.md index 8a5bfcf29..1a3d7337f 100644 --- a/docs/en/commands/interactions/touch/touch-up.md +++ b/docs/en/commands/interactions/touch/touch-up.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/interactions/touch/touch-up.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) # Touch Up Finger up on the screen +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) ```java // Java TouchActions action = new TouchActions(driver); @@ -14,6 +17,7 @@ action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) ```python # Python from appium.webdriver.common.touch_action import TouchAction @@ -25,6 +29,7 @@ actions.perform() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) ```javascript // Javascript // webdriver.io example @@ -36,6 +41,7 @@ driver.touchMultiPerform([ +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) // wd example // Using tapElement method await driver.tapElement(elementOne); @@ -48,23 +54,27 @@ await action.perform(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) ```ruby # Ruby # ruby_lib example touch_action.down(element).up(50, 50).perform +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) # ruby_lib_core example @driver.touch_action.down(element).up(50, 50).perform ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.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/interactions/touch/touch-up.yml) ```csharp // C# // TODO C# sample @@ -74,8 +84,10 @@ touch_action.down(element).up(50, 50).perform ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -88,6 +100,7 @@ touch_action.down(element).up(50, 50).perform | 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/interactions/touch/touch-up.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -102,16 +115,19 @@ touch_action.down(element).up(50, 50).perform ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) `POST /session/:session_id/touch/up` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.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/interactions/touch/touch-up.yml) |name|type|description| |----|----|-----------| @@ -119,9 +135,11 @@ touch_action.down(element).up(50, 50).perform | y | `number` | Y coordinate on the screen | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/touch-up.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchup) diff --git a/docs/en/commands/mobile-command.md b/docs/en/commands/mobile-command.md index 0bf116bb8..5e983aa77 100644 --- a/docs/en/commands/mobile-command.md +++ b/docs/en/commands/mobile-command.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/mobile-command.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) # Execute Mobile Command Execute a native mobile command +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) ```java // Java driver.executeScript("mobile: scroll", ImmutableMap.of("direction", "down")); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) ```python # Python self.driver.execute_script("mobile: scroll", {'direction': 'down'}) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ var result = browser.execute('mobile: scroll', {direction: 'down'}) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) // wd example await driver.execute('mobile: scroll', {direction: 'down'}); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) ```ruby # Ruby # ruby_lib example execute_script("mobile: scroll", { "direction" => "down"}) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) # ruby_lib_core example @driver.execute_script("mobile: scroll", { "direction" => "down"}) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.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/mobile-command.yml) ```csharp // C# // TODO C# sample @@ -53,6 +63,7 @@ execute_script("mobile: scroll", { "direction" => "down"}) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) ## Description Execute a variety of native, mobile commands that aren't associated with a specific endpoint @@ -135,11 +146,14 @@ List of available commands: | mobile:navigateTo | Action to [NavigationView](https://developer.android.com/reference/android/support/design/widget/NavigationView) by [NavigationViewActions#navigateTo](https://developer.android.com/reference/android/support/test/espresso/contrib/NavigationViewActions.html#navigateTo(int)). The view must be a child of a DrawerLayout, of type NavigationView, visible on screen and displayed on screen. | `{element, menuItemId}` | `{element: elementId, menuItemId: 1}` | | mobile:scrollToPage | Action to [ViewPager](https://developer.android.com/reference/android/support/v4/view/ViewPager) by [ViewPagerActions](https://developer.android.com/reference/android/support/test/espresso/contrib/ViewPagerActions). `scrollTo` must be one of `first`, `last`, `left`, `right`. `scrollTo` is used by default if `scrollTo` and `scrollToPage` are provided. | `{scrollTo, scrollToPage, smoothScroll}` | `{element: elementId, scrollTo: 'left', smoothScroll: true}`, `{element: elementId, scrollToPage: 2}`| | mobile:backdoor | Invoke arbitrary methods defined in Android app. The methods must be `public`. `target` is `activity` or `application`. `methods` are methods you would like to invoke. Read docstring of _mobileBackdoor_ method [here](https://github.com/appium/appium-espresso-driver/blob/master/lib/commands/general.js) for more details | `{target, methods}` | `{target: 'activity', methods: [{name: 'method1'}, {name: 'method2', args: [{value: 'hello appium', type: 'java.lang.String'}] }] }` | +| mobile:flashElement | Flashes an element on the screen to visually confirm you are operating on the correct element. Can optionally set `durationMillis` (in ms) and `repeatCount` of animation| `{elementId, durationMillis, repeatCount}` | `{elementId: "1234-abcd-5678", durationMillis: 1000, repeatCount: 10}` | ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -152,6 +166,7 @@ List of available commands: | 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/mobile-command.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -166,16 +181,19 @@ List of available commands: ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) `GET /wd/hub/session/:session_id/execute` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.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/mobile-command.yml) |name|type|description| |----|----|-----------| @@ -183,10 +201,12 @@ List of available commands: | args | `array` | The JSON serializable arguments | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) The command result (`any`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/mobile-command.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-execute-script) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidexecute) diff --git a/docs/en/commands/session/README.md b/docs/en/commands/session/README.md index d767d78ec..4a0a40356 100644 --- a/docs/en/commands/session/README.md +++ b/docs/en/commands/session/README.md @@ -3,9 +3,11 @@ ## Appium API Documentation ### /docs/en/commands/session + [//]: # (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/session/back.md b/docs/en/commands/session/back.md index cfb5a1989..1069e720b 100644 --- a/docs/en/commands/session/back.md +++ b/docs/en/commands/session/back.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/session/back.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) # Go Back Navigate backwards in the browser history, if possible (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) ```java // Java driver.back(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) ```python # Python self.driver.back() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.back(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) // wd example await driver.back(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) ```ruby # Ruby # ruby_lib example back +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) # ruby_lib_core example @driver.back ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.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/session/back.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ back ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ back | 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/session/back.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ back ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) `POST /wd/hub/session/:session_id/back` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.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/session/back.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/back.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-back) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidback) diff --git a/docs/en/commands/session/create.md b/docs/en/commands/session/create.md index ad51e1d63..da1d97dfa 100644 --- a/docs/en/commands/session/create.md +++ b/docs/en/commands/session/create.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/session/create.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) # Create New Session Create a new session +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) ```java // Java DesiredCapabilities desiredCapabilities = new DesiredCapabilities(); @@ -20,6 +23,7 @@ String sessionId = driver.getSessionId().toString(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) ```python # Python desired_caps = desired_caps = { @@ -33,6 +37,7 @@ self.driver = webdriver.Remote('http://127.0.0.1:4723/wd/hub', desired_caps) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) ```javascript // Javascript // webdriver.io example @@ -46,6 +51,7 @@ let client = webdriverio.remote(options); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) // wd example let driver = await wd.promiseChainRemote({ host: '127.0.0.1', @@ -61,6 +67,7 @@ await driver.init(desiredCaps); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) ```ruby # Ruby # ruby_lib example @@ -79,17 +86,20 @@ desired_caps = { Appium::Driver.new(desired_caps).start_driver +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) # ruby_lib_core example ::Appium::Core.for(desired_caps).start_driver ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.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/session/create.yml) ```csharp // C# DesiredCapabilities capabilities = new DesiredCapabilities(); @@ -104,6 +114,7 @@ AndroidDriver driver = new AndroidDriver(new Uri ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) ## Description The server should attempt to create a session that most closely matches the desired and required capabilities. @@ -113,8 +124,10 @@ The server should attempt to create a session that most closely matches the desi ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -127,6 +140,7 @@ The server should attempt to create a session that most closely matches the desi | 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/session/create.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -141,14 +155,17 @@ The server should attempt to create a session that most closely matches the desi ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) `POST /session` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) None ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) |name|type|description| |----|----|-----------| @@ -159,10 +176,12 @@ None | capabilities.firstMatch | `array` | List of capabilities that the remote end tries to match. Matches the first in the list | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) An object describing the session's capabilities (`object`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/create.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-new-session) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#session-1) diff --git a/docs/en/commands/session/delete.md b/docs/en/commands/session/delete.md index 78349edb4..d55b6e0c3 100644 --- a/docs/en/commands/session/delete.md +++ b/docs/en/commands/session/delete.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/session/delete.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) # End Session End the running session +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) ```java // Java driver.quit(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) ```python # Python self.driver.quit() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.end(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) // wd example await driver.quit(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) ```ruby # Ruby # ruby_lib example quit +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) # ruby_lib_core example @driver.quit ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.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/session/delete.yml) ```csharp // C# driver.Quit(); @@ -55,8 +65,10 @@ driver.Quit(); ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ driver.Quit(); | 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/session/delete.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ driver.Quit(); ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) `DELETE /session/:session_id` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) |name|description| |----|-----------| |session_id|ID of the session to delete| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/delete.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-delete-session) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionid) diff --git a/docs/en/commands/session/geolocation/README.md b/docs/en/commands/session/geolocation/README.md index ce6a75f46..5bc79df38 100644 --- a/docs/en/commands/session/geolocation/README.md +++ b/docs/en/commands/session/geolocation/README.md @@ -3,11 +3,14 @@ ## Appium API Documentation ### /docs/en/commands/session/geolocation + [//]: # (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/session/geolocation/get-geolocation.md b/docs/en/commands/session/geolocation/get-geolocation.md index 99ba206f4..96595bdc9 100644 --- a/docs/en/commands/session/geolocation/get-geolocation.md +++ b/docs/en/commands/session/geolocation/get-geolocation.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/session/geolocation/get-geolocation.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) # Get Geolocation Get the current geo location +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) ```java // Java Location location = driver.location(); // Must be a driver that implements LocationContext ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) ```python # Python location = self.driver.location() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let location = driver.location(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) // wd example let location = await driver.getGeoLocation(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) ```ruby # Ruby # ruby_lib example location +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) # ruby_lib_core example @driver.location ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.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/session/geolocation/get-geolocation.yml) ```csharp // C# Location location = driver.Location; @@ -55,8 +65,10 @@ Location location = driver.Location; ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ Location location = driver.Location; | 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/session/geolocation/get-geolocation.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,20 +96,24 @@ Location location = driver.Location; ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) `GET /session/:session_id/location` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.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/session/geolocation/get-geolocation.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) |name|type|description| |----|----|-----------| @@ -105,5 +122,6 @@ None | altitude | `number` | The current geolocation altitude | ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/get-geolocation.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlocation) diff --git a/docs/en/commands/session/geolocation/set-geolocation.md b/docs/en/commands/session/geolocation/set-geolocation.md index e52f31da2..004399cd6 100644 --- a/docs/en/commands/session/geolocation/set-geolocation.md +++ b/docs/en/commands/session/geolocation/set-geolocation.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/session/geolocation/set-geolocation.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) # Set Geolocation Set the current geo location +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) ```java // Java driver.setLocation(new Location(49, 123, 10)); // Must be a driver that implements LocationContext ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) ```python # Python self.driver.set_location(49, 123, 10) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.location({latitude: 121.21, longitude: 11.56, altitude: 94.23}); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) // wd example await driver.setGeoLocation(121.21, 11.56, 10); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) ```ruby # Ruby # ruby_lib example set_location(121.21, 11.56, 94.23) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) # ruby_lib_core example @driver.set_location(121.21, 11.56, 94.23) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.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/session/geolocation/set-geolocation.yml) ```csharp // C# driver.Location.Altitude = 94.23; @@ -57,8 +67,10 @@ driver.Location.Longitude = 11.56; ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -71,6 +83,7 @@ driver.Location.Longitude = 11.56; | 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/session/geolocation/set-geolocation.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -85,16 +98,19 @@ driver.Location.Longitude = 11.56; ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) `POST /session/:session_id/location` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.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/session/geolocation/set-geolocation.yml) |name|type|description| |----|----|-----------| @@ -103,9 +119,11 @@ driver.Location.Longitude = 11.56; | altitude | `number` | The desired geolocation altitude (optional) | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/geolocation/set-geolocation.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidlocation) diff --git a/docs/en/commands/session/get.md b/docs/en/commands/session/get.md index cd0acc2be..6323a6a66 100644 --- a/docs/en/commands/session/get.md +++ b/docs/en/commands/session/get.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/session/get.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) # Get Session Capabilities Retrieve the capabilities of the specified session +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) ```java // Java Map caps = driver.getSessionDetails(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) ```python # Python desired_caps = self.driver.desired_capabilities() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let caps = driver.session('c8db88a0-47a6-47a1-802d-164d746c06aa'); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) // wd example let caps = await driver.sessionCapabilities(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) ```ruby # Ruby # ruby_lib example session_capabilities +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) # ruby_lib_core example @driver.session_capabilities ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.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/session/get.yml) ```csharp // C# ICapabilities caps = driver.Capabilities; @@ -55,8 +65,10 @@ ICapabilities caps = driver.Capabilities; ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ ICapabilities caps = driver.Capabilities; | 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/session/get.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,23 +96,28 @@ ICapabilities caps = driver.Capabilities; ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) `GET /session/:session_id` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.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/session/get.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) An object describing the session's capabilities (`object`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/get.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionid) diff --git a/docs/en/commands/session/logs/README.md b/docs/en/commands/session/logs/README.md index a968a88a9..1a53957a6 100644 --- a/docs/en/commands/session/logs/README.md +++ b/docs/en/commands/session/logs/README.md @@ -3,11 +3,14 @@ ## Appium API Documentation ### /docs/en/commands/session/logs + [//]: # (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/session/logs/get-log-types.md b/docs/en/commands/session/logs/get-log-types.md index ddcb96fce..89f810ba4 100644 --- a/docs/en/commands/session/logs/get-log-types.md +++ b/docs/en/commands/session/logs/get-log-types.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/session/logs/get-log-types.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) # Get available log types Get the log for a given log type. Log buffer is reset after each request +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) ```java // Java Set logTypes = driver.manage().logs().getAvailableLogTypes(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) ```python # Python log_types = driver.log_types(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.log() +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) // wd example const logTypes = await driver.logTypes(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) ```ruby # Ruby # ruby_lib example get_available_log_types +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) # ruby_lib_core example @driver.logs.available_types ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-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/session/logs/get-log-types.yml) ```csharp // C# IReadOnlyCollection logTypes = driver.Manage().Logs.AvailableLogTypes; @@ -55,8 +65,10 @@ IReadOnlyCollection logTypes = driver.Manage().Logs.AvailableLogTypes; ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ IReadOnlyCollection logTypes = driver.Manage().Logs.AvailableLogTypes; | 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/session/logs/get-log-types.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,23 +96,28 @@ IReadOnlyCollection logTypes = driver.Manage().Logs.AvailableLogTypes; ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) `GET /session/:session_id/log/types` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-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/session/logs/get-log-types.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) The list of log types (`array`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log-types.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlogtypes) diff --git a/docs/en/commands/session/logs/get-log.md b/docs/en/commands/session/logs/get-log.md index 4959cc0a0..010c2c44f 100644 --- a/docs/en/commands/session/logs/get-log.md +++ b/docs/en/commands/session/logs/get-log.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/session/logs/get-log.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) # Get Logs Get the log for a given log type. Log buffer is reset after each request +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) ```java // Java LogEntries logEntries = driver.manage().logs().get("driver"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) ```python # Python logs = driver.get_log('driver'); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let logs = driver.log('driver') +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) // wd example const logs = await driver.log('driver'); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) ```ruby # Ruby # ruby_lib example get_log('driver') +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) # ruby_lib_core example @driver.logs.get 'driver' ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.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/session/logs/get-log.yml) ```csharp // C# ILogs logs = driver.Manage().Logs; @@ -55,8 +65,10 @@ ILogs logs = driver.Manage().Logs; ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ ILogs logs = driver.Manage().Logs; | 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/session/logs/get-log.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,25 +96,30 @@ ILogs logs = driver.Manage().Logs; ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) `POST /session/:session_id/log` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.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/session/logs/get-log.yml) |name|type|description| |----|----|-----------| | type | `string` | The log type | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) The list of log entries (`array`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/logs/get-log.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlog) diff --git a/docs/en/commands/session/orientation/README.md b/docs/en/commands/session/orientation/README.md index dc9cef8c4..850b64bdf 100644 --- a/docs/en/commands/session/orientation/README.md +++ b/docs/en/commands/session/orientation/README.md @@ -3,11 +3,14 @@ ## Appium API Documentation ### /docs/en/commands/session/orientation + [//]: # (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/session/orientation/get-orientation.md b/docs/en/commands/session/orientation/get-orientation.md index 75ff14523..ad85de70b 100644 --- a/docs/en/commands/session/orientation/get-orientation.md +++ b/docs/en/commands/session/orientation/get-orientation.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/session/orientation/get-orientation.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) # Get Orientation Get the current device/browser orientation +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) ```java // Java ScreenOrientation orientation = driver.getOrientation(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) ```python # Python orientation = self.driver.orientation() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let orientation = driver.orientation(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) // wd example let orientation = await driver.getOrientation(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) ```ruby # Ruby # ruby_lib example orientation +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) # ruby_lib_core example @driver.orientation ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.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/session/orientation/get-orientation.yml) ```csharp // C# ScreenOrientation orientation = driver.Orientation; @@ -55,8 +65,10 @@ ScreenOrientation orientation = driver.Orientation; ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ ScreenOrientation orientation = driver.Orientation; | 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/session/orientation/get-orientation.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,23 +96,28 @@ ScreenOrientation orientation = driver.Orientation; ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) `GET /session/:session_id/orientation` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.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/session/orientation/get-orientation.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) The current browser orientation {LANDSCAPE|PORTRAIT} (`string`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidorientation) diff --git a/docs/en/commands/session/orientation/set-orientation.md b/docs/en/commands/session/orientation/set-orientation.md index d8da4a9c5..b1ce58017 100644 --- a/docs/en/commands/session/orientation/set-orientation.md +++ b/docs/en/commands/session/orientation/set-orientation.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/session/orientation/set-orientation.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) # Set Orientation Set the current device/browser orientation +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) ```java // Java driver.rotate(ScreenOrientation.LANDSCAPE); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) ```python # Python driver.orientation = "LANDSCAPE" ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.orientation("LANDSCAPE"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) // wd example await driver.setOrientation('LANDSCAPE'); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) ```ruby # Ruby # ruby_lib example rotation = :landscape +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) # ruby_lib_core example @driver.rotation = :landscape ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.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/session/orientation/set-orientation.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ rotation = :landscape ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ rotation = :landscape | 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/session/orientation/set-orientation.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,25 +96,30 @@ rotation = :landscape ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) `POST /session/:session_id/orientation` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.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/session/orientation/set-orientation.yml) |name|type|description| |----|----|-----------| | orientation | `string` | The desired orientation - {LANDSCAPE|PORTRAIT}. | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/set-orientation.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidorientation) diff --git a/docs/en/commands/session/screenshot.md b/docs/en/commands/session/screenshot.md index 80a578c4c..80dc89a12 100644 --- a/docs/en/commands/session/screenshot.md +++ b/docs/en/commands/session/screenshot.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/session/screenshot.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) # Take Screenshot Take a screenshot of the current viewport/window/page +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) ```java // Java File scrFile = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) ```python # Python screenshotBase64 = self.driver.get_screenshot_as_base64() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let screenshot = driver.screenshot(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) // wd example let screenshot = await driver.takeScreenshot(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) ```ruby # Ruby # ruby_lib example driver.screenshot_as(:base64) # via core_lib +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) # ruby_lib_core example @driver.screenshot_as(:base64) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.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/session/screenshot.yml) ```csharp // C# Screenshot screenshot = driver.GetScreenshot(); @@ -53,6 +63,7 @@ Screenshot screenshot = driver.GetScreenshot(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) ## Description Takes a screenshot of the viewport in a native context (iOS, Android) and takes a screenshot of the window in web context @@ -62,8 +73,10 @@ the [Android FLAG_SECURE layout parameter](https://developer.android.com/referen ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -76,6 +89,7 @@ the [Android FLAG_SECURE layout parameter](https://developer.android.com/referen | 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/session/screenshot.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -90,24 +104,29 @@ the [Android FLAG_SECURE layout parameter](https://developer.android.com/referen ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) `GET /wd/hub/session/:session_id/screenshot` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.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/session/screenshot.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) The screenshot as a base64 encoded PNG (`string`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/screenshot.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-take-screenshot) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidscreenshot) diff --git a/docs/en/commands/session/settings/README.md b/docs/en/commands/session/settings/README.md index 50113af2a..430f20335 100644 --- a/docs/en/commands/session/settings/README.md +++ b/docs/en/commands/session/settings/README.md @@ -3,11 +3,14 @@ ## Appium API Documentation ### /docs/en/commands/session/settings + [//]: # (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/session/settings/get-settings.md b/docs/en/commands/session/settings/get-settings.md index 1af0ac135..ac9c593c3 100644 --- a/docs/en/commands/session/settings/get-settings.md +++ b/docs/en/commands/session/settings/get-settings.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/session/settings/get-settings.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) # Retrieve Device Settings Retrieve the current settings on the device +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) ```java // Java Map settings = driver.getSettings(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) ```python # Python self.driver.get_settings ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) ```javascript // Javascript // webdriver.io example @@ -24,26 +29,31 @@ let settings = driver.settings(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) // wd example await driver.settings(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) ```ruby # Ruby # ruby_lib example get_settings +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) # ruby_lib_core example @driver.get_settings ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) ```php // Not supported ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) ```csharp // Not supported ``` @@ -51,8 +61,10 @@ get_settings ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -65,6 +77,7 @@ get_settings | 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/session/settings/get-settings.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -79,23 +92,28 @@ get_settings ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) `GET /wd/hub/session/:session_id/appium/settings` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.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/session/settings/get-settings.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) a JSON hash of all the currently specified settings, see [Settings API](/docs/en/advanced-concepts/settings.md). (`array`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/get-settings.yml) * [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L553) diff --git a/docs/en/commands/session/settings/update-settings.md b/docs/en/commands/session/settings/update-settings.md index dd8115452..d64fed8bb 100644 --- a/docs/en/commands/session/settings/update-settings.md +++ b/docs/en/commands/session/settings/update-settings.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/session/settings/update-settings.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) # Update Device Settings Update the current setting on the device +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) ```java // Java driver.setSetting(Setting.WAIT_FOR_IDLE_TIMEOUT, Duration.ofSeconds(5)); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) ```python # Python self.driver.update_settings({"sample": "value"})) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) ```javascript // Javascript // webdriver.io example @@ -24,26 +29,31 @@ driver.settings({nativeWebTap: true}); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) // wd example await driver.updateSettings({nativeWebTap: true}); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) ```ruby # Ruby # ruby_lib example update_settings(sample: 'value') +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) # ruby_lib_core example @driver.update_settings(sample: 'value') ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) ```php // Not supported ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) ```csharp // Not supported ``` @@ -51,8 +61,10 @@ update_settings(sample: 'value') ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -65,6 +77,7 @@ update_settings(sample: 'value') | 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/session/settings/update-settings.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -79,25 +92,30 @@ update_settings(sample: 'value') ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) `POST /wd/hub/session/:session_id/appium/settings` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.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/session/settings/update-settings.yml) |name|type|description| |----|----|-----------| | settings | `array` | a JSON hash of settings to update, see [Settings API](/docs/en/advanced-concepts/settings.md). | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/settings/update-settings.yml) * [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L553) diff --git a/docs/en/commands/session/source.md b/docs/en/commands/session/source.md index 225a311c7..d5f9f5ee3 100644 --- a/docs/en/commands/session/source.md +++ b/docs/en/commands/session/source.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/session/source.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) # Get Page Source Get the current application hierarchy XML (app) or page source (web) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) ```java // Java String pageSource = driver.getPageSource(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) ```python # Python source = self.driver.page_source ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let source = driver.source(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) // wd example let pageSource = await driver.source(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) ```ruby # Ruby # ruby_lib example page_source +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) # ruby_lib_core example @driver.page_source ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.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/session/source.yml) ```csharp // C# string pageSource = driver.PageSource; @@ -53,6 +63,7 @@ string pageSource = driver.PageSource; ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) ## Description In a web context, the source returns the source HTML of the current window. In a native context (iOS, Android, etc...) it will return the application hierarchy XML. @@ -64,8 +75,10 @@ and creates an XML document. Thus, getting the source can often be an expensive ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -78,6 +91,7 @@ and creates an XML document. Thus, getting the source can often be an expensive | 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/session/source.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -92,24 +106,29 @@ and creates an XML document. Thus, getting the source can often be an expensive ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) `GET /wd/hub/session/:session_id/source` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.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/session/source.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/source.yml) The sources of 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/session/source.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-page-source) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidsource) diff --git a/docs/en/commands/session/timeouts/README.md b/docs/en/commands/session/timeouts/README.md index 62d12ff4e..e9a890d39 100644 --- a/docs/en/commands/session/timeouts/README.md +++ b/docs/en/commands/session/timeouts/README.md @@ -3,12 +3,15 @@ ## Appium API Documentation ### /docs/en/commands/session/timeouts + [//]: # (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/session/timeouts/async-script.md b/docs/en/commands/session/timeouts/async-script.md index 362c08df8..0c4981ebd 100644 --- a/docs/en/commands/session/timeouts/async-script.md +++ b/docs/en/commands/session/timeouts/async-script.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/session/timeouts/async-script.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) # Set Script Timeout Set the amount of time, in milliseconds, that asynchronous scripts executed by [execute async](/docs/en/commands/session/timeouts/async-script.md) are permitted to run before they are aborted (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) ```java // Java driver.manage().timeouts().setScriptTimeout(30, TimeUnit.SECONDS); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) ```python # Python self.driver.set_script_timeout(5000) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.timeoutsAsyncScript(5000) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) // wd example await driver.setAsyncScriptTimeout(5000); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) ```ruby # Ruby # ruby_lib example script_timeout(5) # Ruby translates it to seconds +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) # ruby_lib_core example @driver.script_timeout(5) # Ruby translates it to seconds ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.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/session/timeouts/async-script.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ script_timeout(5) # Ruby translates it to seconds ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ script_timeout(5) # Ruby translates it to seconds | 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/session/timeouts/async-script.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,25 +96,30 @@ script_timeout(5) # Ruby translates it to seconds ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) `POST /session/:session_id/timeouts/async_script` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.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/session/timeouts/async-script.yml) |name|type|description| |----|----|-----------| | ms | `number` | The amount of time, in milliseconds, that time-limited commands are permitted to run | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtimeoutsasync_script) diff --git a/docs/en/commands/session/timeouts/implicit-wait.md b/docs/en/commands/session/timeouts/implicit-wait.md index d609f3319..8f97f4ddf 100644 --- a/docs/en/commands/session/timeouts/implicit-wait.md +++ b/docs/en/commands/session/timeouts/implicit-wait.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/session/timeouts/implicit-wait.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) # Set Implicit Wait Timeout Set the amount of time the driver should wait when searching for elements +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) ```java // Java driver.manage().timeouts().implicitlyWait(30, TimeUnit.SECONDS); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) ```python # Python self.driver.implicitly_wait(5000) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.timeoutsImplicitWait(5000) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) // wd example await driver.setImplicitWaitTimeout(5000); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) ```ruby # Ruby # ruby_lib example manage.timeouts.implicit_wait = 5 # Ruby translates it to seconds +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) # ruby_lib_core example @driver.manage.timeouts.implicit_wait = 5 # Ruby translates it to seconds ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.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/session/timeouts/implicit-wait.yml) ```csharp // C# driver.Manage().Timeouts().ImplicitWait=TimeSpan.FromSeconds(30); @@ -53,6 +63,7 @@ driver.Manage().Timeouts().ImplicitWait=TimeSpan.FromSeconds(30); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) ## Description When searching for a single element, the driver should poll the page until an element is found or @@ -64,8 +75,10 @@ If this command is never sent, the driver should default to an implicit wait of ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -78,6 +91,7 @@ If this command is never sent, the driver should default to an implicit wait of | 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/session/timeouts/implicit-wait.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -92,26 +106,31 @@ If this command is never sent, the driver should default to an implicit wait of ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) `POST /session/:session_id/timeouts/implicit_wait` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.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/session/timeouts/implicit-wait.yml) |name|type|description| |----|----|-----------| | ms | `number` | The amount of time, in milliseconds, that time-limited commands are permitted to run | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/implicit-wait.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-timeouts) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtimeoutsimplicit_wait) diff --git a/docs/en/commands/session/timeouts/timeouts.md b/docs/en/commands/session/timeouts/timeouts.md index e29e527ee..e776b597f 100644 --- a/docs/en/commands/session/timeouts/timeouts.md +++ b/docs/en/commands/session/timeouts/timeouts.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/session/timeouts/timeouts.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) # Set Timeouts Configure the amount of time that a particular type of operation can execute for before they are aborted +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) ```java // Java driver.manage().timeouts().pageLoadTimeout(30, TimeUnit.SECONDS); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) ```python # Python self.driver.set_page_load_timeout(5000) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.timeouts('pageLoad', 5000) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) // wd example await driver.setPageLoadTimeout(5000); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) ```ruby # Ruby # ruby_lib example timeout('pageLoad', 5) # Ruby translates it to seconds +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) # ruby_lib_core example @driver.timeout('pageLoad', 5) # Ruby translates it to seconds ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.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/session/timeouts/timeouts.yml) ```csharp // C# // TODO C# sample @@ -53,14 +63,17 @@ timeout('pageLoad', 5) # Ruby translates it to seconds ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) ## Description The types of timeouts are 'page load', ['script'](/docs/en/commands/session/timeouts/async-script.md) and ['implicit'](/docs/en/commands/session/timeouts/implicit-wait.md). (The example usage is just 'page load') ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -73,6 +86,7 @@ The types of timeouts are 'page load', ['script'](/docs/en/commands/session/time | 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/session/timeouts/timeouts.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -87,16 +101,19 @@ The types of timeouts are 'page load', ['script'](/docs/en/commands/session/time ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) `POST /session/:session_id/timeouts` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.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/session/timeouts/timeouts.yml) |name|type|description| |----|----|-----------| @@ -104,10 +121,12 @@ The types of timeouts are 'page load', ['script'](/docs/en/commands/session/time | ms | `number` | The amount of time, in milliseconds, that time-limited commands are permitted to run | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#set-timeouts) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtimeouts) diff --git a/docs/en/commands/status.md b/docs/en/commands/status.md index 52ce90c24..a322d7fe4 100644 --- a/docs/en/commands/status.md +++ b/docs/en/commands/status.md @@ -1,21 +1,26 @@ [//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) # Status Retrieve the server’s current status +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) ```java // Java // TODO ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) ```python # Python selenium.webdriver.common.utils.is_url_connectable(port) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) ```javascript // Javascript // webdriver.io example @@ -23,28 +28,33 @@ driver.status(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) // wd example await driver.status(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) ```ruby # Ruby # ruby_lib example remote_status +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) # ruby_lib_core example @driver.remote_status ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) ```php # PHP // TODO ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) ```csharp // C# // TODO @@ -52,6 +62,7 @@ remote_status ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) ## Description Returns information about whether a remote end is in a state in which it can create new sessions and can additionally include arbitrary meta information that is specific to the implementation. @@ -62,8 +73,10 @@ Implementations may optionally include additional meta information as part of th ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -76,6 +89,7 @@ Implementations may optionally include additional meta information as part of th | 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/status.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -90,18 +104,22 @@ Implementations may optionally include additional meta information as part of th ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) `GET /wd/hub/status` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) None ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) |name|type|description| |----|----|-----------| @@ -109,6 +127,7 @@ None | build.revision | `string` | The revision of the local source control client from which the server was built | ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/status.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#status) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#status) diff --git a/docs/en/commands/web/README.md b/docs/en/commands/web/README.md index 0a7b11b8c..6261db025 100644 --- a/docs/en/commands/web/README.md +++ b/docs/en/commands/web/README.md @@ -3,9 +3,11 @@ ## Appium API Documentation ### /docs/en/commands/web + [//]: # (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/web/execute-async.md b/docs/en/commands/web/execute-async.md index c9d9d9de7..8d2c494cc 100644 --- a/docs/en/commands/web/execute-async.md +++ b/docs/en/commands/web/execute-async.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/web/execute-async.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) # Execute Async Script Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) ```java // Java ((JavascriptExecutor) driver).executeAsyncScript("window.setTimeout(arguments[arguments.length - 1], 500);"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) ```python # Python self.driver.execute_async_script(‘document.title’) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) ```javascript // Javascript // webdriver.io example @@ -33,28 +38,33 @@ console.log(result.value); // outputs: 10 +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) // wd example await driver.safeExecuteAsync('document.title'); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) ```ruby # Ruby # ruby_lib example execute_async_script("document.title") +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) # ruby_lib_core example @driver.execute_async_script("document.title") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.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/web/execute-async.yml) ```csharp // C# // TODO C# sample @@ -62,6 +72,7 @@ execute_async_script("document.title") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) ## Description The executed script is assumed to be asynchronous and must signal that is done by invoking the provided callback, which is always provided as the final argument to the function. The value to this callback will be returned to the client. @@ -74,8 +85,10 @@ Arguments may be any JSON-primitive, array, or JSON object. JSON objects that de ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -88,6 +101,7 @@ Arguments may be any JSON-primitive, array, or JSON object. JSON objects that 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/web/execute-async.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -102,16 +116,19 @@ Arguments may be any JSON-primitive, array, or JSON object. JSON objects that 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/web/execute-async.yml) `GET /wd/hub/session/:session_id/execute_async` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.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/web/execute-async.yml) |name|type|description| |----|----|-----------| @@ -119,10 +136,12 @@ Arguments may be any JSON-primitive, array, or JSON object. JSON objects that de | args | `array` | The script arguments | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) The script result (`any`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute-async.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-execute-async-script) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidexecute_async) diff --git a/docs/en/commands/web/execute.md b/docs/en/commands/web/execute.md index cb349f739..63d7a83b6 100644 --- a/docs/en/commands/web/execute.md +++ b/docs/en/commands/web/execute.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/web/execute.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) # Execute Script Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) ```java // Java ((JavascriptExecutor) driver).executeScript("window.setTimeout(arguments[arguments.length - 1], 500);"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) ```python # Python self.driver.execute_script(‘document.title’) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) ```javascript // Javascript // webdriver.io example @@ -30,28 +35,33 @@ console.log(result.value); // outputs: 10 +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) // wd example await driver.execute('document.title'); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) ```ruby # Ruby # ruby_lib example execute_script("document.title") +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) # ruby_lib_core example @driver.execute_script("document.title") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.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/web/execute.yml) ```csharp // C# // TODO C# sample @@ -59,6 +69,7 @@ execute_script("document.title") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) ## Description The executed script is assumed to be synchronous and the result of evaluating the script is returned to the client. @@ -71,8 +82,10 @@ For `execute` in the native context, see [Mobile Commands](/docs/en/commands/mob ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -85,6 +98,7 @@ For `execute` in the native context, see [Mobile Commands](/docs/en/commands/mob | 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/web/execute.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -99,16 +113,19 @@ For `execute` in the native context, see [Mobile Commands](/docs/en/commands/mob ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) `GET /wd/hub/session/:session_id/execute_async` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.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/web/execute.yml) |name|type|description| |----|----|-----------| @@ -116,10 +133,12 @@ For `execute` in the native context, see [Mobile Commands](/docs/en/commands/mob | args | `array` | The script arguments | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) The script result (`any`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/execute.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-execute-script) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidexecute_async) diff --git a/docs/en/commands/web/frame/README.md b/docs/en/commands/web/frame/README.md index a5da0da09..076e334bd 100644 --- a/docs/en/commands/web/frame/README.md +++ b/docs/en/commands/web/frame/README.md @@ -3,11 +3,14 @@ ## Appium API Documentation ### /docs/en/commands/web/frame + [//]: # (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/web/frame/parent.md b/docs/en/commands/web/frame/parent.md index 2950ab0e2..6e2eb9812 100644 --- a/docs/en/commands/web/frame/parent.md +++ b/docs/en/commands/web/frame/parent.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/web/frame/parent.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) # Switch to Parent Frame Change focus to the parent context (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) ```java // Java driver.switchTo().parentFrame(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) ```python # Python self.driver.switch_to.parent() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) ```javascript // Javascript // webdriver.io example @@ -24,26 +29,31 @@ driver.frameParent(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) // Not supported ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) ```ruby # Ruby # ruby_lib example parent_frame +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) # ruby_lib_core example @driver.parent_frame ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.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/web/frame/parent.yml) ```csharp // C# // TODO C# sample @@ -51,14 +61,17 @@ parent_frame ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) ## Description If the current context is the top level browsing context, the context remains unchanged ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -71,6 +84,7 @@ If the current context is the top level browsing context, the context remains un | 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/web/frame/parent.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -85,24 +99,29 @@ If the current context is the top level browsing context, the context remains un ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) `GET /wd/hub/session/:session_id/url` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.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/web/frame/parent.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) The current URL (`string`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/parent.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-switch-to-parent-frame) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidframeparent) diff --git a/docs/en/commands/web/frame/switch.md b/docs/en/commands/web/frame/switch.md index 45a83d4a6..27dbaf483 100644 --- a/docs/en/commands/web/frame/switch.md +++ b/docs/en/commands/web/frame/switch.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/web/frame/switch.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) # Switch to Frame Change focus to another frame on the page (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) ```java // Java driver.switchTo().frame(3); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) ```python # Python self.driver.switch_to.frame(3) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.frame(3); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) // wd example await driver.frame(3); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) ```ruby # Ruby # ruby_lib example switch_to.frame(3) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) # ruby_lib_core example @driver.switch_to.frame(3) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.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/web/frame/switch.yml) ```csharp // C# // TODO C# sample @@ -53,14 +63,17 @@ switch_to.frame(3) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) ## Description If the frame id is null, the server should switch to the page's default content ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -73,6 +86,7 @@ If the frame id is null, the server should switch to the page's default content | 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/web/frame/switch.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -87,26 +101,31 @@ If the frame id is null, the server should switch to the page's default content ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) `POST /wd/hub/session/:session_id/frame` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.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/web/frame/switch.yml) |name|type|description| |----|----|-----------| | id | `string|number|null|WebElement JSON Object` | Identifier for the frame to change focus to. | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-switch-to-frame) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidurl) diff --git a/docs/en/commands/web/navigation/README.md b/docs/en/commands/web/navigation/README.md index fd511a2e6..4c42119cf 100644 --- a/docs/en/commands/web/navigation/README.md +++ b/docs/en/commands/web/navigation/README.md @@ -3,9 +3,11 @@ ## Appium API Documentation ### /docs/en/commands/web/navigation + [//]: # (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/web/navigation/back.md b/docs/en/commands/web/navigation/back.md index 8af09c06e..568c509a3 100644 --- a/docs/en/commands/web/navigation/back.md +++ b/docs/en/commands/web/navigation/back.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/web/navigation/back.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) # Go Back Navigate backwards in the browser history, if possible (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) ```java // Java driver.back(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) ```python # Python self.driver.back() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.back(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) // wd example await driver.back(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) ```ruby # Ruby # ruby_lib example back +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) # ruby_lib_core example @driver.back ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.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/web/navigation/back.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ back ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ back | 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/web/navigation/back.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ back ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) `POST /wd/hub/session/:session_id/back` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.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/web/navigation/back.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/back.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-back) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidback) diff --git a/docs/en/commands/web/navigation/forward.md b/docs/en/commands/web/navigation/forward.md index a90e780cb..45e371e2d 100644 --- a/docs/en/commands/web/navigation/forward.md +++ b/docs/en/commands/web/navigation/forward.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/web/navigation/forward.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) # Go Forward Navigate forwards in the browser history, if possible (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) ```java // Java driver.forward(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) ```python # Python self.driver.forward() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.forward(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) // wd example await driver.forward(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) ```ruby # Ruby # ruby_lib example forward +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) # ruby_lib_core example @driver.forward ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.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/web/navigation/forward.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ forward ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ forward | 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/web/navigation/forward.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ forward ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) `POST /wd/hub/session/:session_id/forward` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.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/web/navigation/forward.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/forward.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-forward) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidforward) diff --git a/docs/en/commands/web/navigation/go-to-url.md b/docs/en/commands/web/navigation/go-to-url.md index afdd4c443..6c3188b52 100644 --- a/docs/en/commands/web/navigation/go-to-url.md +++ b/docs/en/commands/web/navigation/go-to-url.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/web/navigation/go-to-url.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) # Navigate to URL Navigate to a new URL (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) ```java // Java driver.get("http://appium.io/"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) ```python # Python self.driver.get("http://appium.io/") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.url("http://appium.io"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) // wd example await driver.url("http://appium.io/"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) ```ruby # Ruby # ruby_lib example get("http://appium.io") +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) # ruby_lib_core example @driver.get("http://appium.io") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.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/web/navigation/go-to-url.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ get("http://appium.io") ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ get("http://appium.io") | 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/web/navigation/go-to-url.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,26 +96,31 @@ get("http://appium.io") ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) `POST /wd/hub/session/:session_id/url` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.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/web/navigation/go-to-url.yml) |name|type|description| |----|----|-----------| | url | `string` | The URL to navigate to | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/go-to-url.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-go) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidurl) diff --git a/docs/en/commands/web/navigation/refresh.md b/docs/en/commands/web/navigation/refresh.md index 99912960d..5aa1e8e56 100644 --- a/docs/en/commands/web/navigation/refresh.md +++ b/docs/en/commands/web/navigation/refresh.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/web/navigation/refresh.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) # Refresh Refresh the current page. (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) ```java // Java driver.refresh(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) ```python # Python self.driver.refresh() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.refresh(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) // wd example await driver.refresh(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) ```ruby # Ruby # ruby_lib example refresh +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) # ruby_lib_core example @driver.refresh ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.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/web/navigation/refresh.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ refresh ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ refresh | 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/web/navigation/refresh.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ refresh ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) `POST /wd/hub/session/:session_id/refresh` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.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/web/navigation/refresh.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/refresh.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-refresh) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidrefresh) diff --git a/docs/en/commands/web/navigation/url.md b/docs/en/commands/web/navigation/url.md index 2d10788bc..6186209b8 100644 --- a/docs/en/commands/web/navigation/url.md +++ b/docs/en/commands/web/navigation/url.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/web/navigation/url.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) # Get URL Retrieve the URL of the current page (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) ```java // Java String url = driver.getCurrentUrl(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) ```python # Python url = self.driver.current_url() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let url = driver.url(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) // wd example let url = await driver.url(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) ```ruby # Ruby # ruby_lib example current_url +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) # ruby_lib_core example @driver.current_url ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.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/web/navigation/url.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ current_url ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ current_url | 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/web/navigation/url.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ current_url ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) `GET /wd/hub/session/:session_id/url` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.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/web/navigation/url.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) The current URL (`string`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/navigation/url.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-current-url) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidurl) diff --git a/docs/en/commands/web/storage/README.md b/docs/en/commands/web/storage/README.md index 5cc045f33..32dd8b7e4 100644 --- a/docs/en/commands/web/storage/README.md +++ b/docs/en/commands/web/storage/README.md @@ -3,9 +3,11 @@ ## Appium API Documentation ### /docs/en/commands/web/storage + [//]: # (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/web/storage/delete-all-cookies.md b/docs/en/commands/web/storage/delete-all-cookies.md index 3d51b2bdd..9b2a6f2d4 100644 --- a/docs/en/commands/web/storage/delete-all-cookies.md +++ b/docs/en/commands/web/storage/delete-all-cookies.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/web/storage/delete-all-cookies.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) # Delete All Cookies Delete all cookies visible to current page (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) ```java // Java driver.manage().deleteAllCookies(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) ```python # Python self.driver.delete_all_cookies() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.cookie("delete"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) // wd example await driver.deleteAllCookies(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) ```ruby # Ruby # ruby_lib example delete_all_cookies +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) # ruby_lib_core example @driver.delete_all_cookies ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.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/web/storage/delete-all-cookies.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ delete_all_cookies ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ delete_all_cookies | 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/web/storage/delete-all-cookies.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ delete_all_cookies ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) `DELETE /wd/hub/session/:sessionId/cookie` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.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/web/storage/delete-all-cookies.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-all-cookies.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-delete-all-cookies) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#delete-sessionsessionidcookie) diff --git a/docs/en/commands/web/storage/delete-cookie.md b/docs/en/commands/web/storage/delete-cookie.md index d534a2a9b..560860d14 100644 --- a/docs/en/commands/web/storage/delete-cookie.md +++ b/docs/en/commands/web/storage/delete-cookie.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/web/storage/delete-cookie.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) # Delete Cookie Delete the cookie with the given name (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) ```java // Java driver.manage().deleteCookieNamed("cookie_name"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) ```python # Python self.driver.delete_cookie("cookie_name") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.cookie("delete", "cookie_name"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) // wd example await driver.deleteCookie("cookie_name"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) ```ruby # Ruby # ruby_lib example delete_cookie("cookie_name") +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) # ruby_lib_core example @driver.delete_cookie("cookie_name") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.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/web/storage/delete-cookie.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ delete_cookie("cookie_name") ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ delete_cookie("cookie_name") | 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/web/storage/delete-cookie.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,10 +96,12 @@ delete_cookie("cookie_name") ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) `DELETE /wd/hub/session/:sessionId/cookie/:name` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) |name|description| |----|-----------| @@ -94,14 +109,17 @@ delete_cookie("cookie_name") |name|Name of cookie to delete| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/delete-cookie.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-delete-cookie) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidcookiename) diff --git a/docs/en/commands/web/storage/get-all-cookies.md b/docs/en/commands/web/storage/get-all-cookies.md index 2bb45f06f..cc7ccf83d 100644 --- a/docs/en/commands/web/storage/get-all-cookies.md +++ b/docs/en/commands/web/storage/get-all-cookies.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/web/storage/get-all-cookies.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) # Get All Cookies Retrieve all cookies visible to the current page (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) ```java // Java Set allcookies = driver.manage().getCookies(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) ```python # Python cookies = self.driver.get_cookies() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let cookies = driver.cookie(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) // wd example let cookies = await driver.allCookies(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) ```ruby # Ruby # ruby_lib example all_cookies +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) # ruby_lib_core example @driver.all_cookies ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.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/web/storage/get-all-cookies.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ all_cookies ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ all_cookies | 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/web/storage/get-all-cookies.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ all_cookies ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) `GET /wd/hub/session/:sessionId/cookie` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.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/web/storage/get-all-cookies.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) A list of cookies (`array`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/get-all-cookies.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-all-cookies) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidcookie) diff --git a/docs/en/commands/web/storage/set-cookie.md b/docs/en/commands/web/storage/set-cookie.md index 49e5c9c91..35fc20851 100644 --- a/docs/en/commands/web/storage/set-cookie.md +++ b/docs/en/commands/web/storage/set-cookie.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/web/storage/set-cookie.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) # Set Cookie Set a cookie (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) ```java // Java driver.manage().addCookie(new Cookie("foo", "bar")); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) ```python # Python self.driver.add_cookie({name: 'foo', value: 'bar'}) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) ```javascript // Javascript // webdriver.io example @@ -27,28 +32,33 @@ driver.cookie('post', { +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) // wd example let cookies = await driver.setCookie({name: 'foo', value: 'bar'}); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) ```ruby # Ruby # ruby_lib example add_cookie(:name => 'foo', :value => 'bar') +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) # ruby_lib_core example @driver.add_cookie(:name => 'foo', :value => 'bar') ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.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/web/storage/set-cookie.yml) ```csharp // C# // TODO C# sample @@ -58,8 +68,10 @@ add_cookie(:name => 'foo', :value => 'bar') ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -72,6 +84,7 @@ add_cookie(:name => 'foo', :value => 'bar') | 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/web/storage/set-cookie.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -86,26 +99,31 @@ add_cookie(:name => 'foo', :value => 'bar') ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) `POST /wd/hub/session/:sessionId/cookie` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.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/web/storage/set-cookie.yml) |name|type|description| |----|----|-----------| | cookie | `object` | The cookie to add | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/storage/set-cookie.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-delete-cookie) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidcookie) diff --git a/docs/en/commands/web/window/README.md b/docs/en/commands/web/window/README.md index 213f179fa..718549ba5 100644 --- a/docs/en/commands/web/window/README.md +++ b/docs/en/commands/web/window/README.md @@ -3,9 +3,11 @@ ## Appium API Documentation ### /docs/en/commands/web/window + [//]: # (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/web/window/close-window.md b/docs/en/commands/web/window/close-window.md index 4f56d3630..3a0e6f5e8 100644 --- a/docs/en/commands/web/window/close-window.md +++ b/docs/en/commands/web/window/close-window.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/web/window/close-window.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) # Close Window Close the current window (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) ```java // Java driver.close(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) ```python # Python self.driver.close() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.close(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) // wd example await driver.close(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) ```ruby # Ruby # ruby_lib example close +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) # ruby_lib_core example @driver.close ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.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/web/window/close-window.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ close ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ close | 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/web/window/close-window.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ close ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) `DELETE /wd/hub/session/:session_id/window` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.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/web/window/close-window.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/close-window.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#close-window) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidwindow) diff --git a/docs/en/commands/web/window/get-handle.md b/docs/en/commands/web/window/get-handle.md index 72f066452..d6a05000f 100644 --- a/docs/en/commands/web/window/get-handle.md +++ b/docs/en/commands/web/window/get-handle.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/web/window/get-handle.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) # Get Window Handle Retrieve the current window handle (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) ```java // Java String windowHandle = driver.getWindowHandle(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) ```python # Python window_handle = self.driver.current_window_handle() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let handle = driver.windowHandle(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) // wd example let windowHandle = await driver.windowHandle(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) ```ruby # Ruby # ruby_lib example window_handle +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) # ruby_lib_core example @driver.window_handle ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.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/web/window/get-handle.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ window_handle ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ window_handle | 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/web/window/get-handle.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ window_handle ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) `GET /wd/hub/session/:session_id/window_handle` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.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/web/window/get-handle.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handle.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-window-handle) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidwindow_handle) diff --git a/docs/en/commands/web/window/get-handles.md b/docs/en/commands/web/window/get-handles.md index 74b221680..61dbbd138 100644 --- a/docs/en/commands/web/window/get-handles.md +++ b/docs/en/commands/web/window/get-handles.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/web/window/get-handles.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) # Get Window Handles Retrieve the list of all window handles available to the session (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) ```java // Java Set windowHandles = driver.getWindowHandles(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) ```python # Python window_handles = self.driver.window_handles() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let handles = driver.windowHandles(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) // wd example let windowHandle = await driver.windowHandles(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) ```ruby # Ruby # ruby_lib example window_handles +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) # ruby_lib_core example @driver.window_handles ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.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/web/window/get-handles.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ window_handles ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ window_handles | 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/web/window/get-handles.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,24 +96,29 @@ window_handles ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) `GET /wd/hub/session/:session_id/window_handles` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.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/web/window/get-handles.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) A list of window handles (`array`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-handles.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-window-handles) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidwindow_handles) diff --git a/docs/en/commands/web/window/get-window-position.md b/docs/en/commands/web/window/get-window-position.md index 4f8a07295..fbf9e6447 100644 --- a/docs/en/commands/web/window/get-window-position.md +++ b/docs/en/commands/web/window/get-window-position.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/web/window/get-window-position.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) # Get Window Position Get the position of the specified window (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) ```java // Java Point windowPosition = driver.manage().window().getPosition(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) ```python # Python handle_one_position = self.driver.get_window_position() @@ -18,6 +22,7 @@ handle_two_position = self.driver.get_window_position("handleName") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) ```javascript // Javascript // webdriver.io example @@ -26,12 +31,14 @@ let handleTwoPosition = driver.windowHandlePosition("handleName"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) // wd example let handleOnePosition = await driver.getWindowPosition(); let handleTwoPosition = await driver.getWindowPosition("handleName"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) ```ruby # Ruby # ruby_lib example @@ -39,18 +46,21 @@ window_position window_position("handleName") +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) # ruby_lib_core example @driver.window_position @driver.window_position("handleName") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.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/web/window/get-window-position.yml) ```csharp // C# // TODO C# sample @@ -60,8 +70,10 @@ window_position("handleName") ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -74,6 +86,7 @@ window_position("handleName") | 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/web/window/get-window-position.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -88,10 +101,12 @@ window_position("handleName") ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) `GET /wd/hub/session/:session_id/window/:window_handle/position` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) |name|description| |----|-----------| @@ -99,10 +114,12 @@ window_position("handleName") |window_handle|Handle of the window to get position of. If 'current' it will get position of current window.| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) |name|type|description| |----|----|-----------| @@ -110,5 +127,6 @@ None | y | `number` | The y coordinate relative to the top left corner of the window | ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-position.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidwindowwindowhandleposition) diff --git a/docs/en/commands/web/window/get-window-size.md b/docs/en/commands/web/window/get-window-size.md index ce233d74c..a87b0b90f 100644 --- a/docs/en/commands/web/window/get-window-size.md +++ b/docs/en/commands/web/window/get-window-size.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/web/window/get-window-size.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) # Get Window Size Get the size of the specified window (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) ```java // Java Dimension windowSize = driver.manage().window().getSize(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) ```python # Python handle_one_size = self.driver.get_window_size() @@ -18,6 +22,7 @@ handle_two_size = self.driver.get_window_size("handleName") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) ```javascript // Javascript // webdriver.io example @@ -26,12 +31,14 @@ let handleTwoSize = driver.windowHandleSize("handleName"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) // wd example let handleOneSize = await driver.getWindowSize(); let handleTwoSize = await driver.getWindowSize("handleName"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) ```ruby # Ruby # ruby_lib example @@ -39,18 +46,21 @@ window_size window_size("handleName") +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) # ruby_lib_core example @driver.window_size @driver.window_size("handleName") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.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/web/window/get-window-size.yml) ```csharp // C# // TODO C# sample @@ -60,8 +70,10 @@ window_size("handleName") ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -74,6 +86,7 @@ window_size("handleName") | 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/web/window/get-window-size.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -88,10 +101,12 @@ window_size("handleName") ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) `GET /wd/hub/session/:session_id/window/:window_handle/size` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) |name|description| |----|-----------| @@ -99,10 +114,12 @@ window_size("handleName") |window_handle|Handle of the window to get size of. If 'current' it will get size of current window.| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) |name|type|description| |----|----|-----------| @@ -110,5 +127,6 @@ None | height | `number` | The height of the window | ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/get-window-size.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#get-sessionsessionidwindowwindowhandlesize) diff --git a/docs/en/commands/web/window/maximize-window.md b/docs/en/commands/web/window/maximize-window.md index bf7cc5b33..e56a1e221 100644 --- a/docs/en/commands/web/window/maximize-window.md +++ b/docs/en/commands/web/window/maximize-window.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/web/window/maximize-window.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) # Maximize Window Maximize the specified window (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) ```java // Java driver.manage().window().maximize(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) ```python # Python self.driver.maximize_window(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) ```javascript // Javascript // webdriver.io example @@ -25,29 +30,34 @@ driver.windowHandleMaximize(); // Current window +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) // wd example await driver.maximize("handleName"); // Set size of window by handle name await driver.maximize(); // Set current window ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) ```ruby # Ruby # ruby_lib example resize_to(10, 10) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) # ruby_lib_core example @driver.resize_to(10, 10) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.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/web/window/maximize-window.yml) ```csharp // C# // TODO C# sample @@ -57,8 +67,10 @@ resize_to(10, 10) ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -71,6 +83,7 @@ resize_to(10, 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/web/window/maximize-window.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -85,10 +98,12 @@ resize_to(10, 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/web/window/maximize-window.yml) `POST /wd/hub/session/:session_id/window/:window_handle/maximize` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) |name|description| |----|-----------| @@ -96,14 +111,17 @@ resize_to(10, 10) |window_handle|Handle of the window to maximize. If 'current' it will maximize current window| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/maximize-window.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-maximize-window) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidwindowwindowhandlemaximize) diff --git a/docs/en/commands/web/window/set-window-position.md b/docs/en/commands/web/window/set-window-position.md index 0205cfdbe..1d940b3fe 100644 --- a/docs/en/commands/web/window/set-window-position.md +++ b/docs/en/commands/web/window/set-window-position.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/web/window/set-window-position.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) # Set Window Position Change the position of the specified window (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) ```java // Java driver.manage().window().setPosition(new Dimension(10, 10)); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) ```python # Python self.driver.set_window_position(10, 10) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) ```javascript // Javascript // webdriver.io example @@ -25,29 +30,34 @@ driver.windowHandlePosition({x: 10, y: 10}); // Current window +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) // wd example await driver.setWindowPosition(10, 10, "handleName"); // Set position of window by handle name await driver.setWindowPosition(10, 10); // Set current window ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) ```ruby # Ruby # ruby_lib example reposition_window(10, 10) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) # ruby_lib_core example @driver.reposition_window(10, 10) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.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/web/window/set-window-position.yml) ```csharp // C# // TODO C# sample @@ -57,8 +67,10 @@ reposition_window(10, 10) ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -71,6 +83,7 @@ reposition_window(10, 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/web/window/set-window-position.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -85,10 +98,12 @@ reposition_window(10, 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/web/window/set-window-position.yml) `POST /wd/hub/session/:session_id/window/:window_handle/position` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) |name|description| |----|-----------| @@ -96,6 +111,7 @@ reposition_window(10, 10) |window_handle|Handle of the window to get position of. If 'current' it will get position of current window.| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) |name|type|description| |----|----|-----------| @@ -103,9 +119,11 @@ reposition_window(10, 10) | y | `number` | The y coordinate relative to the top left corner of the window | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-position.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidwindowwindowhandleposition) diff --git a/docs/en/commands/web/window/set-window-size.md b/docs/en/commands/web/window/set-window-size.md index 4c2a883a9..2d8ee8e01 100644 --- a/docs/en/commands/web/window/set-window-size.md +++ b/docs/en/commands/web/window/set-window-size.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/web/window/set-window-size.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) # Set Window Size Change the size of the specified window (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) ```java // Java driver.manage().window().setSize(new Dimension(10, 10)); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) ```python # Python self.driver.set_window_size(10, 10) ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) ```javascript // Javascript // webdriver.io example @@ -25,29 +30,34 @@ driver.windowHandleSize({height: 10, width: 10}); // Current window +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) // wd example await driver.setWindowSize(10, 10, "handleName"); // Set size of window by handle name await driver.setWindowSize(10, 10); // Set current window ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) ```ruby # Ruby # ruby_lib example maximize_window +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) # ruby_lib_core example @driver.maximize_window ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.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/web/window/set-window-size.yml) ```csharp // C# // TODO C# sample @@ -57,8 +67,10 @@ maximize_window ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -71,6 +83,7 @@ maximize_window | 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/web/window/set-window-size.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -85,10 +98,12 @@ maximize_window ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) `POST /wd/hub/session/:session_id/window/:window_handle/size` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) |name|description| |----|-----------| @@ -96,6 +111,7 @@ maximize_window |window_handle|Handle of the window to get size of. If 'current' it will get size of current window.| ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) |name|type|description| |----|----|-----------| @@ -103,9 +119,11 @@ maximize_window | height | `number` | The new window height | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window-size.yml) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#post-sessionsessionidwindowwindowhandlesize) diff --git a/docs/en/commands/web/window/set-window.md b/docs/en/commands/web/window/set-window.md index f9f3293d5..8d847c021 100644 --- a/docs/en/commands/web/window/set-window.md +++ b/docs/en/commands/web/window/set-window.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/web/window/set-window.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) # Switch to Window Change focus to another window (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) ```java // Java driver.switchTo().window("handle"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) ```python # Python self.driver.switch_to.window("handle") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ driver.window("handle"); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) // wd example await driver.window("handle"); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) ```ruby # Ruby # ruby_lib example switch_to.window("handle") +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) # ruby_lib_core example @driver.switch_to.window("handle") ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.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/web/window/set-window.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ switch_to.window("handle") ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ switch_to.window("handle") | 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/web/window/set-window.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,26 +96,31 @@ switch_to.window("handle") ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) `POST /wd/hub/session/:session_id/window` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.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/web/window/set-window.yml) |name|type|description| |----|----|-----------| | name | `string` | The window to change focus to | ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) null ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/set-window.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-switch-to-window) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidwindow) diff --git a/docs/en/commands/web/window/title.md b/docs/en/commands/web/window/title.md index d19dbb120..e31e28f6e 100644 --- a/docs/en/commands/web/window/title.md +++ b/docs/en/commands/web/window/title.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/web/window/title.yml) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) # Get Title Get the current page title (Web context only) +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) ## Example Usage +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) ```java // Java String title = driver.getTitle(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) ```python # Python title = self.driver.title() ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) ```javascript // Javascript // webdriver.io example @@ -24,28 +29,33 @@ let handle = driver.title(); +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) // wd example let title = await driver.title(); ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) ```ruby # Ruby # ruby_lib example title +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) # ruby_lib_core example @driver.title ``` +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.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/web/window/title.yml) ```csharp // C# // TODO C# sample @@ -55,8 +65,10 @@ title ## Support +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) ### Appium Server +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| @@ -69,6 +81,7 @@ title | 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/web/window/title.yml) |Language|Support|Documentation| |--------|-------|-------------| @@ -83,22 +96,27 @@ title ## HTTP API Specifications ### Endpoint +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) `GET /wd/hub/session/:session_id/title` ### URL Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) None ### JSON Parameters +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) None ### Response +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) The current page title (`string`) ## See Also +[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/window/title.yml) * [W3C Specification](https://www.w3.org/TR/webdriver/#dfn-get-title) * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtitle)