mirror of
https://github.com/appium/appium.git
synced 2026-02-05 00:58:56 -06:00
Update generated docs [ci skip] (#11847)
This commit is contained in:
Appium Triager
committed by
Dan Graham
Dan Graham
parent
735df9aee9
commit
7e61cbb2e0
@@ -3,8 +3,9 @@
|
||||
## Appium API Documentation
|
||||
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/status.md'>Status</a></li>
|
||||
<li><a href='/docs/en/commands/mobile-command.md'>Execute Mobile Command</a></li>
|
||||
@@ -44,6 +45,12 @@
|
||||
<li><a href='/docs/en/commands/device/app/remove-app.md'>Remove App</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/get-app-strings.md'>Get App Strings</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/end-test-coverage.md'>End Test Coverage</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/clipboard'>Clipboard</a><ul> <li><a href='/docs/en/commands/device/clipboard/get-clipboard.md'>Get Clipboard</a></li>
|
||||
<li><a href='/docs/en/commands/device/clipboard/set-Clipboard.md'>Set Clipboard</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/emulator'>Emulator</a><ul> <li><a href='/docs/en/commands/device/emulator/power_ac.md'>Power AC</a></li>
|
||||
<li><a href='/docs/en/commands/device/emulator/power_capacity.md'>Power Capacity</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/files'>Files</a><ul> <li><a href='/docs/en/commands/device/files/push-file.md'>Push File</a></li>
|
||||
<li><a href='/docs/en/commands/device/files/pull-file.md'>Pull File</a></li>
|
||||
@@ -161,3 +168,4 @@
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -3,8 +3,9 @@
|
||||
## Appium API Documentation
|
||||
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/status.md'>Status</a></li>
|
||||
<li><a href='/docs/en/commands/mobile-command.md'>Execute Mobile Command</a></li>
|
||||
@@ -44,6 +45,12 @@
|
||||
<li><a href='/docs/en/commands/device/app/remove-app.md'>Remove App</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/get-app-strings.md'>Get App Strings</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/end-test-coverage.md'>End Test Coverage</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/clipboard'>Clipboard</a><ul> <li><a href='/docs/en/commands/device/clipboard/get-clipboard.md'>Get Clipboard</a></li>
|
||||
<li><a href='/docs/en/commands/device/clipboard/set-Clipboard.md'>Set Clipboard</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/emulator'>Emulator</a><ul> <li><a href='/docs/en/commands/device/emulator/power_ac.md'>Power AC</a></li>
|
||||
<li><a href='/docs/en/commands/device/emulator/power_capacity.md'>Power Capacity</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/files'>Files</a><ul> <li><a href='/docs/en/commands/device/files/push-file.md'>Push File</a></li>
|
||||
<li><a href='/docs/en/commands/device/files/pull-file.md'>Pull File</a></li>
|
||||
@@ -161,3 +168,4 @@
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/context/get-context.md'>Get Context</a></li>
|
||||
<li><a href='/docs/en/commands/context/get-contexts.md'>Get All Contexts</a></li>
|
||||
<li><a href='/docs/en/commands/context/set-context.md'>Set Context</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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<String> 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<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-contexts.yml)
|
||||
|
||||
* [JSONWP Specification](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts)
|
||||
|
||||
@@ -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<String> 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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/activity'>Activity</a><ul> <li><a href='/docs/en/commands/device/activity/start-activity.md'>Start Activity</a></li>
|
||||
<li><a href='/docs/en/commands/device/activity/current-activity.md'>Current Activity</a></li>
|
||||
@@ -20,6 +22,12 @@
|
||||
<li><a href='/docs/en/commands/device/app/remove-app.md'>Remove App</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/get-app-strings.md'>Get App Strings</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/end-test-coverage.md'>End Test Coverage</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/clipboard'>Clipboard</a><ul> <li><a href='/docs/en/commands/device/clipboard/get-clipboard.md'>Get Clipboard</a></li>
|
||||
<li><a href='/docs/en/commands/device/clipboard/set-Clipboard.md'>Set Clipboard</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/emulator'>Emulator</a><ul> <li><a href='/docs/en/commands/device/emulator/power_ac.md'>Power AC</a></li>
|
||||
<li><a href='/docs/en/commands/device/emulator/power_capacity.md'>Power Capacity</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/files'>Files</a><ul> <li><a href='/docs/en/commands/device/files/push-file.md'>Push File</a></li>
|
||||
<li><a href='/docs/en/commands/device/files/pull-file.md'>Pull File</a></li>
|
||||
@@ -62,3 +70,4 @@
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/activity/start-activity.md'>Start Activity</a></li>
|
||||
<li><a href='/docs/en/commands/device/activity/current-activity.md'>Current Activity</a></li>
|
||||
<li><a href='/docs/en/commands/device/activity/current-package.md'>Current Package</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/app/install-app.md'>Install App</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/is-app-installed.md'>Is App Installed</a></li>
|
||||
@@ -18,3 +20,4 @@
|
||||
<li><a href='/docs/en/commands/device/app/end-test-coverage.md'>End Test Coverage</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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<String, String> 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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/authentication/finger-print.md'>Finger Print</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/files/push-file.md'>Push File</a></li>
|
||||
<li><a href='/docs/en/commands/device/files/pull-file.md'>Pull File</a></li>
|
||||
<li><a href='/docs/en/commands/device/files/pull-folder.md'>Pull Folder</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/interactions/shake.md'>Shake</a></li>
|
||||
<li><a href='/docs/en/commands/device/interactions/lock.md'>Lock</a></li>
|
||||
@@ -14,3 +16,4 @@
|
||||
<li><a href='/docs/en/commands/device/interactions/rotate.md'>Rotate</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/keys/press-keycode.md'>Press keycode</a></li>
|
||||
<li><a href='/docs/en/commands/device/keys/long-press-keycode.md'>Long press keycode</a></li>
|
||||
@@ -13,3 +15,4 @@
|
||||
<li><a href='/docs/en/commands/device/keys/is-keyboard-shown.md'>Is Keyboard Shown</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/network/toggle-airplane-mode.md'>Toggle Airplane Mode</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/toggle-data.md'>Toggle Data</a></li>
|
||||
@@ -17,3 +19,4 @@
|
||||
<li><a href='/docs/en/commands/device/network/gsm-voice.md'>GSM Voice</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/performance-data/get-performance-data.md'>Get Performance Data</a></li>
|
||||
<li><a href='/docs/en/commands/device/performance-data/performance-data-types.md'>Performance Data Types</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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<List<Object>> 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<string>`)
|
||||
|
||||
## 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)
|
||||
|
||||
@@ -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<String> 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<string>`)
|
||||
|
||||
## 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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/recording-screen/start-recording-screen.md'>Start Screen Recording</a></li>
|
||||
<li><a href='/docs/en/commands/device/recording-screen/stop-recording-screen.md'>Stop Screen Recording</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/simulator/touch-id.md'>Perform Touch ID</a></li>
|
||||
<li><a href='/docs/en/commands/device/simulator/toggle-touch-id-enrollment.md'>Toggle Touch ID Enrollment</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/device/system/open-notifications.md'>Open Notifications</a></li>
|
||||
<li><a href='/docs/en/commands/device/system/system-bars.md'>System Bars</a></li>
|
||||
<li><a href='/docs/en/commands/device/system/system-time.md'>System Time</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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<String, String> 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<object>`)
|
||||
|
||||
## 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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/element/find-element.md'>Find Element</a></li>
|
||||
<li><a href='/docs/en/commands/element/find-elements.md'>Find Elements</a></li>
|
||||
@@ -31,3 +33,4 @@
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/element/actions/click.md'>Click</a></li>
|
||||
<li><a href='/docs/en/commands/element/actions/send-keys.md'>Send Keys</a></li>
|
||||
<li><a href='/docs/en/commands/element/actions/clear.md'>Clear</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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<string>` | 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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/element/attributes/text.md'>Text</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/name.md'>Name</a></li>
|
||||
@@ -20,3 +22,4 @@
|
||||
<li><a href='/docs/en/commands/element/attributes/location-in-view.md'>Location in View</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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<MobileElement> 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)
|
||||
|
||||
@@ -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<MobileElement> 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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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<MobileElement> 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)
|
||||
|
||||
@@ -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<MobileElement> 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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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<MobileElement> 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)
|
||||
|
||||
@@ -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<string>` | 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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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<MobileElement> 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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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<MobileElement> elementsOne = (MobileElement) driver.findElementsByAccessibilityId("SomeAccessibilityID");
|
||||
@@ -12,12 +15,14 @@ List<MobileElement> 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<String>`)
|
||||
|
||||
## 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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/element/other/submit.md'>Submit</a></li>
|
||||
<li><a href='/docs/en/commands/element/other/active.md'>Active Element</a></li>
|
||||
<li><a href='/docs/en/commands/element/other/equals-element.md'>Equals Element</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/interactions/mouse'>Mouse</a><ul> <li><a href='/docs/en/commands/interactions/mouse/moveto.md'>Move To</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/click.md'>Click</a></li>
|
||||
@@ -27,3 +29,4 @@
|
||||
<li><a href='/docs/en/commands/interactions/actions.md'>W3C Actions</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/moveto.md'>Move To</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/click.md'>Click</a></li>
|
||||
@@ -14,3 +16,4 @@
|
||||
<li><a href='/docs/en/commands/interactions/mouse/button-up.md'>Button Up</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.)
|
||||
<div class="api-index">
|
||||
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/interactions/touch/tap.md'>Single Tap</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/double-tap.md'>Double Tap</a></li>
|
||||
@@ -19,3 +21,4 @@
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-perform.md'>Touch Perform</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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('<ELEMENT_ID>', 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)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user