Update generated docs [ci skip] (#11954)

This commit is contained in:
Appium Triager
2019-01-07 15:39:50 -08:00
committed by Dan Graham
parent 25040552ed
commit 97f324a58b
7 changed files with 379 additions and 0 deletions
+3
View File
@@ -43,6 +43,9 @@
<li><a href='/docs/en/commands/device/app/close-app.md'>Close App</a></li>
<li><a href='/docs/en/commands/device/app/reset-app.md'>Reset App</a></li>
<li><a href='/docs/en/commands/device/app/remove-app.md'>Remove App</a></li>
<li><a href='/docs/en/commands/device/app/activate-app.md'>Activate App</a></li>
<li><a href='/docs/en/commands/device/app/terminate-app.md'>Terminate App</a></li>
<li><a href='/docs/en/commands/device/app/app-state.md'>Get App State</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>
+3
View File
@@ -43,6 +43,9 @@
<li><a href='/docs/en/commands/device/app/close-app.md'>Close App</a></li>
<li><a href='/docs/en/commands/device/app/reset-app.md'>Reset App</a></li>
<li><a href='/docs/en/commands/device/app/remove-app.md'>Remove App</a></li>
<li><a href='/docs/en/commands/device/app/activate-app.md'>Activate App</a></li>
<li><a href='/docs/en/commands/device/app/terminate-app.md'>Terminate App</a></li>
<li><a href='/docs/en/commands/device/app/app-state.md'>Get App State</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>
+3
View File
@@ -20,6 +20,9 @@
<li><a href='/docs/en/commands/device/app/close-app.md'>Close App</a></li>
<li><a href='/docs/en/commands/device/app/reset-app.md'>Reset App</a></li>
<li><a href='/docs/en/commands/device/app/remove-app.md'>Remove App</a></li>
<li><a href='/docs/en/commands/device/app/activate-app.md'>Activate App</a></li>
<li><a href='/docs/en/commands/device/app/terminate-app.md'>Terminate App</a></li>
<li><a href='/docs/en/commands/device/app/app-state.md'>Get App State</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>
+3
View File
@@ -16,6 +16,9 @@
<li><a href='/docs/en/commands/device/app/close-app.md'>Close App</a></li>
<li><a href='/docs/en/commands/device/app/reset-app.md'>Reset App</a></li>
<li><a href='/docs/en/commands/device/app/remove-app.md'>Remove App</a></li>
<li><a href='/docs/en/commands/device/app/activate-app.md'>Activate App</a></li>
<li><a href='/docs/en/commands/device/app/terminate-app.md'>Terminate App</a></li>
<li><a href='/docs/en/commands/device/app/app-state.md'>Get App State</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>
+122
View File
@@ -0,0 +1,122 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
# Activate App
Activate 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/activate-app.yml)
## Example Usage
```java
// Java
driver.activateApp('com.apple.Preferences');
driver.activateApp('io.appium.android.apis');
```
```python
# Python
driver.activate_app('com.apple.Preferences')
driver.activate_app('io.appium.android.apis')
```
```javascript
// Javascript
// webdriver.io example
// Supports only `mobile: queryAppState` for iOS, XCUITest
// wd example
// Supports only `mobile: queryAppState` for iOS, XCUITest
```
```ruby
# Ruby
# ruby_lib example
activate_app('com.apple.Preferences')
activate_app('io.appium.android.apis')
# ruby_lib_core example
@driver.activate_app('com.apple.Preferences')
@driver.activate_app('io.appium.android.apis')
```
```php
# PHP
// Supports only `mobile: queryAppState` for iOS, XCUITest
```
```csharp
// C#
// Supports only `mobile: queryAppState` for iOS, XCUITest
```
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
## Description
iOS tests with XCUITest can also use the `mobile: activateApp` method. See detailed [documentation](http://appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-activateapp).
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
## Support
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
### Appium Server
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
| iOS | [XCUITest](/docs/en/drivers/ios-xcuitest.md) | 9.3+ | 1.6.0+ | All |
| | [UIAutomation](/docs/en/drivers/ios-uiautomation.md) | None | None | None |
| Android | [Espresso](/docs/en/drivers/android-espresso.md) | ?+ | 1.9.0+ | All |
| | [UiAutomator2](/docs/en/drivers/android-uiautomator2.md) | ?+ | 1.6.0+ | All |
| | [UiAutomator](/docs/en/drivers/android-uiautomator.md) | 4.2+ | All | All |
| Mac | [Mac](/docs/en/drivers/mac.md) | None | None | None |
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
### Appium Clients
|Language|Support|Documentation|
|--------|-------|-------------|
|[Java](https://github.com/appium/java-client/releases/latest)| All | [appium.github.io](https://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#activateApp-java.lang.String-) |
|[Python](https://github.com/appium/python-client/releases/latest)| All | [github.com](https://github.com/appium/python-client/blob/master/appium/webdriver/extensions/applications.py) |
|[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All | |
|[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All | [github.com](https://github.com/admc/wd/blob/master/lib/commands.js) |
|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All | [www.rubydoc.info](https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#activate_app-instance_method) |
|[PHP](https://github.com/appium/php-client/releases/latest)| All | [github.com](https://github.com/appium/php-client/) |
|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All | [github.com](https://github.com/appium/appium-dotnet-driver/) |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
## HTTP API Specifications
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
### Endpoint
`POST /wd/hub/session/:session_id/appium/device/activate_app`
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
### URL Parameters
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
### JSON Parameters
|name|type|description|
|----|----|-----------|
| bundleId or appId | `string` | BundleId for iOS. Package name for Android. |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
### Response
null
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/activate-app.yml)
## See Also
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L427)
+122
View File
@@ -0,0 +1,122 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
# Get app state
Get the given app status 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/app-state.yml)
## Example Usage
```java
// Java
driver.queryAppState('com.apple.Preferences');
driver.queryAppState('io.appium.android.apis');
```
```python
# Python
driver.query_app_state('com.apple.Preferences')
driver.query_app_state('io.appium.android.apis')
```
```javascript
// Javascript
// webdriver.io example
// Supports only `mobile: queryAppState` for iOS, XCUITest
// wd example
// Supports only `mobile: queryAppState` for iOS, XCUITest
```
```ruby
# Ruby
# ruby_lib example
app_state('com.apple.Preferences')
query_app_state('io.appium.android.apis') # `query_` prefix is also available
# ruby_lib_core example
@driver.app_state('com.apple.Preferences')
@driver.query_app_state('io.appium.android.apis') # `query_` prefix is also available
```
```php
# PHP
// Supports only `mobile: queryAppState` for iOS, XCUITest
```
```csharp
// C#
// Supports only `mobile: queryAppState` for iOS, XCUITest
```
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
## Description
iOS tests with XCUITest can also use the `mobile: queryAppState` method. See detailed [documentation](http://appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-queryappstate).
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
## Support
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
### Appium Server
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
| iOS | [XCUITest](/docs/en/drivers/ios-xcuitest.md) | 9.3+ | 1.6.0+ | All |
| | [UIAutomation](/docs/en/drivers/ios-uiautomation.md) | None | None | None |
| Android | [Espresso](/docs/en/drivers/android-espresso.md) | ?+ | 1.9.0+ | All |
| | [UiAutomator2](/docs/en/drivers/android-uiautomator2.md) | ?+ | 1.6.0+ | All |
| | [UiAutomator](/docs/en/drivers/android-uiautomator.md) | 4.2+ | All | All |
| Mac | [Mac](/docs/en/drivers/mac.md) | None | None | None |
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
### Appium Clients
|Language|Support|Documentation|
|--------|-------|-------------|
|[Java](https://github.com/appium/java-client/releases/latest)| All | [appium.github.io](https://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#queryAppState-java.lang.String-) |
|[Python](https://github.com/appium/python-client/releases/latest)| All | [github.com](https://github.com/appium/python-client/blob/master/appium/webdriver/extensions/applications.py) |
|[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All | |
|[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All | [github.com](https://github.com/admc/wd/blob/master/lib/commands.js) |
|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All | [www.rubydoc.info](https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Base/Driver#app_state-instance_method) |
|[PHP](https://github.com/appium/php-client/releases/latest)| All | [github.com](https://github.com/appium/php-client/) |
|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All | [github.com](https://github.com/appium/appium-dotnet-driver/) |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
## HTTP API Specifications
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
### Endpoint
`GET /wd/hub/session/:session_id/appium/device/app_state`
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
### URL Parameters
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
### JSON Parameters
|name|type|description|
|----|----|-----------|
| bundleId or appId | `string` | BundleId for iOS. Package name for Android. |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
### Response
Current the target app status. (Clients wrap the response properly) `0` is not installed. `1` is not running. `2` is running in background or suspended. `3` is running in background. `4` is running in foreground. (`number`)
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/app-state.yml)
## See Also
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L462)
@@ -0,0 +1,123 @@
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
# Terminate App
Terminate the given app 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/terminate-app.yml)
## Example Usage
```java
// Java
driver.terminateApp('com.apple.Preferences');
driver.terminateApp('io.appium.android.apis');
```
```python
# Python
driver.terminate_app('com.apple.Preferences')
driver.terminate_app('io.appium.android.apis')
```
```javascript
// Javascript
// webdriver.io example
// Supports only `mobile: queryAppState` for iOS, XCUITest
// wd example
// Supports only `mobile: queryAppState` for iOS, XCUITest
```
```ruby
# Ruby
# ruby_lib example
terminate_app('com.apple.Preferences')
terminate_app('io.appium.android.apis')
# ruby_lib_core example
@driver.terminate_app('com.apple.Preferences')
@driver.terminate_app('io.appium.android.apis')
```
```php
# PHP
// Supports only `mobile: queryAppState` for iOS, XCUITest
```
```csharp
// C#
// Supports only `mobile: queryAppState` for iOS, XCUITest
```
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
## Description
iOS tests with XCUITest can also use the `mobile: terminateApp` method. See detailed [documentation](http://appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-terminateapp).
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
## Support
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
### Appium Server
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
| iOS | [XCUITest](/docs/en/drivers/ios-xcuitest.md) | 9.3+ | 1.6.0+ | All |
| | [UIAutomation](/docs/en/drivers/ios-uiautomation.md) | None | None | None |
| Android | [Espresso](/docs/en/drivers/android-espresso.md) | ?+ | 1.9.0+ | All |
| | [UiAutomator2](/docs/en/drivers/android-uiautomator2.md) | ?+ | 1.6.0+ | All |
| | [UiAutomator](/docs/en/drivers/android-uiautomator.md) | 4.2+ | All | All |
| Mac | [Mac](/docs/en/drivers/mac.md) | None | None | None |
| Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
### Appium Clients
|Language|Support|Documentation|
|--------|-------|-------------|
|[Java](https://github.com/appium/java-client/releases/latest)| All | [appium.github.io](https://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#terminateApp-java.lang.String-) |
|[Python](https://github.com/appium/python-client/releases/latest)| All | [github.com](https://github.com/appium/python-client/blob/master/appium/webdriver/extensions/applications.py) |
|[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All | |
|[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All | [github.com](https://github.com/admc/wd/blob/master/lib/commands.js) |
|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All | [www.rubydoc.info](https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Base/Driver#terminate_app-instance_method) |
|[PHP](https://github.com/appium/php-client/releases/latest)| All | [github.com](https://github.com/appium/php-client/) |
|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All | [github.com](https://github.com/appium/appium-dotnet-driver/) |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
## HTTP API Specifications
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
### Endpoint
`POST /wd/hub/session/:session_id/appium/device/terminate_app`
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
### URL Parameters
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
### JSON Parameters
|name|type|description|
|----|----|-----------|
| bundleId or appId | `string` | BundleId for iOS. Package name for Android. |
| timeout | `number` | (Only Android) Timeout to retry terminate the app. |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
### Response
null
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/app/terminate-app.yml)
## See Also
* [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L445)