mirror of
https://github.com/appium/appium.git
synced 2026-05-03 08:51:18 -05:00
Add index to each directory in command documentation (#10922)
* Add index to each directory in command documentation * Add do-not-edit note to top of template
This commit is contained in:
Isaac A. Murchie
@@ -1,11 +1,15 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
{{#if path}}
|
||||
### {{path}}
|
||||
{{/if}}
|
||||
|
||||
<div class="api-index">
|
||||
{{#*inline "commands"}}
|
||||
{{#each commands}}
|
||||
<li>
|
||||
{{#if path}}<a href='{{path}}'>{{name}}</a>{{else}}{{name}}<ul>{{>commands}}</ul>{{/if}}
|
||||
</li>
|
||||
<li>{{#if commands}}<a href='{{path}}'>{{name}}</a><ul>{{>commands}}</ul>{{else}}<a href='{{path}}'>{{name}}</a>{{/if}}</li>
|
||||
{{/each}}
|
||||
{{/inline}}
|
||||
|
||||
|
||||
+41
-8
@@ -1,6 +1,6 @@
|
||||
import path from 'path';
|
||||
import yaml from 'yaml-js';
|
||||
import { fs, mkdirp } from 'appium-support';
|
||||
import { fs, mkdirp, util } from 'appium-support';
|
||||
import validate from 'validate.js';
|
||||
import Handlebars from 'handlebars';
|
||||
import replaceExt from 'replace-ext';
|
||||
@@ -179,9 +179,6 @@ async function generateCommands () {
|
||||
}
|
||||
|
||||
async function generateCommandIndex () {
|
||||
const apiIndex = path.resolve(__dirname, '..', 'docs', 'en', 'about-appium', 'api.md');
|
||||
log(`Creating API index '${apiIndex}'`);
|
||||
|
||||
function getTree (element, path) {
|
||||
let node = {
|
||||
name: element[0],
|
||||
@@ -189,6 +186,7 @@ async function generateCommandIndex () {
|
||||
if (!_.isArray(element[1])) {
|
||||
node.path = `${path}/${element[1]}`;
|
||||
} else {
|
||||
node.path = `${path}/${element[1][0]}`;
|
||||
const name = element[1].shift();
|
||||
node.commands = [];
|
||||
for (let subElement of element[1]) {
|
||||
@@ -202,15 +200,50 @@ async function generateCommandIndex () {
|
||||
// {commands: [{name: '', path: ''}, {name: '', commands: [...]}]}
|
||||
const toc = require(path.resolve(__dirname, '..', 'docs', 'toc.js'));
|
||||
const commandToc = _.find(toc.en, (value) => value.indexOf('Commands') === 0);
|
||||
let commands = [];
|
||||
// const commands = commandToc[1].slice(1).map((el) => getTree(el, '/docs/en/commands'));
|
||||
const commands = [];
|
||||
for (let el of commandToc[1].slice(1)) {
|
||||
commands.push(getTree(el, '/docs/en/commands'));
|
||||
}
|
||||
|
||||
const commandTemplate = Handlebars.compile(await fs.readFile(path.resolve(__dirname, 'api-template.md'), 'utf8'), {noEscape: true, strict: true});
|
||||
const commandMarkdown = commandTemplate({commands});
|
||||
await fs.writeFile(apiIndex, commandMarkdown, 'utf8');
|
||||
log(`Done writing API index`);
|
||||
|
||||
async function writeIndex (index, commands, indexPath) {
|
||||
log(`Creating API index '${index}'`);
|
||||
const commandMarkdown = commandTemplate({
|
||||
commands,
|
||||
path: indexPath,
|
||||
});
|
||||
await fs.writeFile(index, commandMarkdown, 'utf8');
|
||||
}
|
||||
|
||||
const apiIndex = path.resolve(__dirname, '..', 'docs', 'en', 'about-appium', 'api.md');
|
||||
await writeIndex(apiIndex, commands);
|
||||
log(`Done writing main API index`);
|
||||
|
||||
async function writeIndividualIndexes (command) {
|
||||
if (!util.hasValue(command.commands)) {
|
||||
// this is a leaf, so end
|
||||
return;
|
||||
}
|
||||
|
||||
// write this node
|
||||
const relPath = command.path.startsWith(path.sep) ? command.path.substring(1) : command.path;
|
||||
const index = path.resolve(__dirname, '..', relPath, 'README.md');
|
||||
await writeIndex(index, command.commands, command.path);
|
||||
|
||||
// go through all the sub-commands
|
||||
for (const el of command.commands) {
|
||||
await writeIndividualIndexes(el);
|
||||
}
|
||||
}
|
||||
|
||||
// go through the full tree and generate readme files
|
||||
const index = path.resolve(__dirname, '..', 'docs', 'en', 'commands', 'README.md');
|
||||
await writeIndex(index, commands);
|
||||
for (const el of commands) {
|
||||
await writeIndividualIndexes(el);
|
||||
}
|
||||
}
|
||||
|
||||
async function main () {
|
||||
|
||||
+150
-441
@@ -1,448 +1,157 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li>
|
||||
Session<ul> <li>
|
||||
<a href='/docs/en/commands/session/create.md'>Create</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/delete.md'>End</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/get.md'>Get Session Capabilities</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/back.md'>Go Back</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/screenshot.md'>Screenshot</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/source.md'>Source</a>
|
||||
</li>
|
||||
<li>
|
||||
Timeouts<ul> <li>
|
||||
<a href='/docs/en/commands/session/timeouts/timeouts.md'>Timeouts</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/timeouts/implicit-wait.md'>Implicit Wait</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/timeouts/async-script.md'>Async Script</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Orientation<ul> <li>
|
||||
<a href='/docs/en/commands/session/orientation/get-orientation.md'>Get Orientation</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/orientation/set-orientation.md'>Set Orientation</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Geolocation<ul> <li>
|
||||
<a href='/docs/en/commands/session/geolocation/get-geolocation.md'>Get Geolocation</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/geolocation/set-geolocation.md'>Set Geolocation</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Logs<ul> <li>
|
||||
<a href='/docs/en/commands/session/logs/get-log-types.md'>Get Log Types</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/logs/get-log.md'>Get Logs</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Settings<ul> <li>
|
||||
<a href='/docs/en/commands/session/settings/update-settings.md'>Update Settings</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/session/settings/get-settings.md'>Get Device Settings</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Device<ul> <li>
|
||||
Activity<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>
|
||||
</li>
|
||||
<li>
|
||||
App<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>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/app/launch-app.md'>Launch App</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/app/background-app.md'>Background App</a>
|
||||
</li>
|
||||
<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/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>
|
||||
Files<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>
|
||||
</li>
|
||||
<li>
|
||||
Interactions<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>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/interactions/unlock.md'>Unlock</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/interactions/is-locked.md'>Is Locked</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/interactions/rotate.md'>Rotate</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Keys<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>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/keys/hide-keyboard.md'>Hide Keyboard</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/keys/is-keyboard-shown.md'>Is Keyboard Shown</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Network<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>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/network/toggle-wifi.md'>Toggle WiFi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/network/toggle-location-services.md'>Toggle Location Services</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/network/send-sms.md'>Send SMS</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/network/gsm-call.md'>GSM Call</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/network/gsm-signal.md'>GSM Signal</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/device/network/gsm-voice.md'>GSM Voice</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Performance Data<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>
|
||||
</li>
|
||||
<li>
|
||||
Simulator<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>
|
||||
</li>
|
||||
<li>
|
||||
System<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>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Element<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>
|
||||
<li>
|
||||
Actions<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>
|
||||
</li>
|
||||
<li>
|
||||
Attributes<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>
|
||||
<li>
|
||||
<a href='/docs/en/commands/element/attributes/attribute.md'>Attribute</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/element/attributes/selected.md'>Selected</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/element/attributes/enabled.md'>Enabled</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/element/attributes/enabled.md'>Displayed</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/element/attributes/location.md'>Location</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/element/attributes/size.md'>Size</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/element/attributes/rect.md'>Rect</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/element/attributes/css-property.md'>CSS Property</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/element/attributes/location-in-view.md'>Location in View</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Other<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>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Context<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>
|
||||
</li>
|
||||
<li>
|
||||
Interactions<ul> <li>
|
||||
Mouse<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>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/mouse/doubleclick.md'>Double Click</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/mouse/button-down.md'>Button Down</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/mouse/button-up.md'>Button Up</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Touch<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>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/touch/move.md'>Move</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/touch/touch-down.md'>Touch Down</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/touch/touch-up.md'>Touch Up</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/touch/long-press.md'>Long Press</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/touch/scroll.md'>Scroll</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/touch/flick.md'>Flick</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/touch/multi-touch-perform.md'>Multi Touch Perform</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/interactions/touch/touch-perform.md'>Touch Perform</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Web<ul> <li>
|
||||
Window<ul> <li>
|
||||
<a href='/docs/en/commands/web/window/set-window.md'>Set Window</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/window/close-window.md'>Close Window</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/window/get-handle.md'>Get Handle</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/window/get-handles.md'>Get Handles</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/window/title.md'>Get Title</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/window/get-window-size.md'>Get Window Size</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/window/set-window-size.md'>Set Window Size</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/window/get-window-position.md'>Get Window Position</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/window/set-window-position.md'>Set Window Position</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/window/maximize-window.md'>Maximize Window</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Navigation<ul> <li>
|
||||
<a href='/docs/en/commands/web/navigation/go-to-url.md'>Go to URL</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/navigation/url.md'>Get URL</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/navigation/back.md'>Back</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/navigation/forward.md'>Forward</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/navigation/refresh.md'>Refresh</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Storage<ul> <li>
|
||||
<a href='/docs/en/commands/web/storage/get-all-cookies.md'>Get All Cookies</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/storage/set-cookie.md'>Set Cookie</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/storage/delete-cookie.md'>Delete Cookie</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/storage/delete-all-cookies.md'>Delete All Cookies</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Frame<ul> <li>
|
||||
<a href='/docs/en/commands/web/frame/switch.md'>Switch to Frame</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/frame/parent.md'>Switch to Parent Frame</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/execute-async.md'>Execute Async</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/en/commands/web/execute.md'>Execute</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/session'>Session</a><ul> <li><a href='/docs/en/commands/session/create.md'>Create</a></li>
|
||||
<li><a href='/docs/en/commands/session/delete.md'>End</a></li>
|
||||
<li><a href='/docs/en/commands/session/get.md'>Get Session Capabilities</a></li>
|
||||
<li><a href='/docs/en/commands/session/back.md'>Go Back</a></li>
|
||||
<li><a href='/docs/en/commands/session/screenshot.md'>Screenshot</a></li>
|
||||
<li><a href='/docs/en/commands/session/source.md'>Source</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts'>Timeouts</a><ul> <li><a href='/docs/en/commands/session/timeouts/timeouts.md'>Timeouts</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts/implicit-wait.md'>Implicit Wait</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts/async-script.md'>Async Script</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/orientation'>Orientation</a><ul> <li><a href='/docs/en/commands/session/orientation/get-orientation.md'>Get Orientation</a></li>
|
||||
<li><a href='/docs/en/commands/session/orientation/set-orientation.md'>Set Orientation</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/geolocation'>Geolocation</a><ul> <li><a href='/docs/en/commands/session/geolocation/get-geolocation.md'>Get Geolocation</a></li>
|
||||
<li><a href='/docs/en/commands/session/geolocation/set-geolocation.md'>Set Geolocation</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/logs'>Logs</a><ul> <li><a href='/docs/en/commands/session/logs/get-log-types.md'>Get Log Types</a></li>
|
||||
<li><a href='/docs/en/commands/session/logs/get-log.md'>Get Logs</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/settings'>Settings</a><ul> <li><a href='/docs/en/commands/session/settings/update-settings.md'>Update Settings</a></li>
|
||||
<li><a href='/docs/en/commands/session/settings/get-settings.md'>Get Device Settings</a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device'>Device</a><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>
|
||||
<li><a href='/docs/en/commands/device/activity/current-package.md'>Current Package</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/app'>App</a><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>
|
||||
<li><a href='/docs/en/commands/device/app/launch-app.md'>Launch App</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/background-app.md'>Background App</a></li>
|
||||
<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/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/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>
|
||||
<li><a href='/docs/en/commands/device/files/pull-folder.md'>Pull Folder</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/interactions'>Interactions</a><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>
|
||||
<li><a href='/docs/en/commands/device/interactions/unlock.md'>Unlock</a></li>
|
||||
<li><a href='/docs/en/commands/device/interactions/is-locked.md'>Is Locked</a></li>
|
||||
<li><a href='/docs/en/commands/device/interactions/rotate.md'>Rotate</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/keys'>Keys</a><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>
|
||||
<li><a href='/docs/en/commands/device/keys/hide-keyboard.md'>Hide Keyboard</a></li>
|
||||
<li><a href='/docs/en/commands/device/keys/is-keyboard-shown.md'>Is Keyboard Shown</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/network'>Network</a><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>
|
||||
<li><a href='/docs/en/commands/device/network/toggle-wifi.md'>Toggle WiFi</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/toggle-location-services.md'>Toggle Location Services</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/send-sms.md'>Send SMS</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-call.md'>GSM Call</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-signal.md'>GSM Signal</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-voice.md'>GSM Voice</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/performance-data'>Performance Data</a><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></li>
|
||||
<li><a href='/docs/en/commands/device/simulator'>Simulator</a><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></li>
|
||||
<li><a href='/docs/en/commands/device/system'>System</a><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></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/element'>Element</a><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>
|
||||
<li><a href='/docs/en/commands/element/actions'>Actions</a><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></li>
|
||||
<li><a href='/docs/en/commands/element/attributes'>Attributes</a><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>
|
||||
<li><a href='/docs/en/commands/element/attributes/attribute.md'>Attribute</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/selected.md'>Selected</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/enabled.md'>Enabled</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/enabled.md'>Displayed</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/location.md'>Location</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/size.md'>Size</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/rect.md'>Rect</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/css-property.md'>CSS Property</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/location-in-view.md'>Location in View</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/element/other'>Other</a><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></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/context'>Context</a><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></li>
|
||||
<li><a href='/docs/en/commands/interactions'>Interactions</a><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>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/doubleclick.md'>Double Click</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/button-down.md'>Button Down</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/button-up.md'>Button Up</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch'>Touch</a><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>
|
||||
<li><a href='/docs/en/commands/interactions/touch/move.md'>Move</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-down.md'>Touch Down</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-up.md'>Touch Up</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/long-press.md'>Long Press</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/scroll.md'>Scroll</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/flick.md'>Flick</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/multi-touch-perform.md'>Multi Touch Perform</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-perform.md'>Touch Perform</a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web'>Web</a><ul> <li><a href='/docs/en/commands/web/window'>Window</a><ul> <li><a href='/docs/en/commands/web/window/set-window.md'>Set Window</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/close-window.md'>Close Window</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-handle.md'>Get Handle</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-handles.md'>Get Handles</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/title.md'>Get Title</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-window-size.md'>Get Window Size</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/set-window-size.md'>Set Window Size</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-window-position.md'>Get Window Position</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/set-window-position.md'>Set Window Position</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/maximize-window.md'>Maximize Window</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/navigation'>Navigation</a><ul> <li><a href='/docs/en/commands/web/navigation/go-to-url.md'>Go to URL</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/url.md'>Get URL</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/back.md'>Back</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/forward.md'>Forward</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/refresh.md'>Refresh</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/storage'>Storage</a><ul> <li><a href='/docs/en/commands/web/storage/get-all-cookies.md'>Get All Cookies</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/set-cookie.md'>Set Cookie</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/delete-cookie.md'>Delete Cookie</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/delete-all-cookies.md'>Delete All Cookies</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/frame'>Frame</a><ul> <li><a href='/docs/en/commands/web/frame/switch.md'>Switch to Frame</a></li>
|
||||
<li><a href='/docs/en/commands/web/frame/parent.md'>Switch to Parent Frame</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/execute-async.md'>Execute Async</a></li>
|
||||
<li><a href='/docs/en/commands/web/execute.md'>Execute</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,157 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/session'>Session</a><ul> <li><a href='/docs/en/commands/session/create.md'>Create</a></li>
|
||||
<li><a href='/docs/en/commands/session/delete.md'>End</a></li>
|
||||
<li><a href='/docs/en/commands/session/get.md'>Get Session Capabilities</a></li>
|
||||
<li><a href='/docs/en/commands/session/back.md'>Go Back</a></li>
|
||||
<li><a href='/docs/en/commands/session/screenshot.md'>Screenshot</a></li>
|
||||
<li><a href='/docs/en/commands/session/source.md'>Source</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts'>Timeouts</a><ul> <li><a href='/docs/en/commands/session/timeouts/timeouts.md'>Timeouts</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts/implicit-wait.md'>Implicit Wait</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts/async-script.md'>Async Script</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/orientation'>Orientation</a><ul> <li><a href='/docs/en/commands/session/orientation/get-orientation.md'>Get Orientation</a></li>
|
||||
<li><a href='/docs/en/commands/session/orientation/set-orientation.md'>Set Orientation</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/geolocation'>Geolocation</a><ul> <li><a href='/docs/en/commands/session/geolocation/get-geolocation.md'>Get Geolocation</a></li>
|
||||
<li><a href='/docs/en/commands/session/geolocation/set-geolocation.md'>Set Geolocation</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/logs'>Logs</a><ul> <li><a href='/docs/en/commands/session/logs/get-log-types.md'>Get Log Types</a></li>
|
||||
<li><a href='/docs/en/commands/session/logs/get-log.md'>Get Logs</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/settings'>Settings</a><ul> <li><a href='/docs/en/commands/session/settings/update-settings.md'>Update Settings</a></li>
|
||||
<li><a href='/docs/en/commands/session/settings/get-settings.md'>Get Device Settings</a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device'>Device</a><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>
|
||||
<li><a href='/docs/en/commands/device/activity/current-package.md'>Current Package</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/app'>App</a><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>
|
||||
<li><a href='/docs/en/commands/device/app/launch-app.md'>Launch App</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/background-app.md'>Background App</a></li>
|
||||
<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/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/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>
|
||||
<li><a href='/docs/en/commands/device/files/pull-folder.md'>Pull Folder</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/interactions'>Interactions</a><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>
|
||||
<li><a href='/docs/en/commands/device/interactions/unlock.md'>Unlock</a></li>
|
||||
<li><a href='/docs/en/commands/device/interactions/is-locked.md'>Is Locked</a></li>
|
||||
<li><a href='/docs/en/commands/device/interactions/rotate.md'>Rotate</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/keys'>Keys</a><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>
|
||||
<li><a href='/docs/en/commands/device/keys/hide-keyboard.md'>Hide Keyboard</a></li>
|
||||
<li><a href='/docs/en/commands/device/keys/is-keyboard-shown.md'>Is Keyboard Shown</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/network'>Network</a><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>
|
||||
<li><a href='/docs/en/commands/device/network/toggle-wifi.md'>Toggle WiFi</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/toggle-location-services.md'>Toggle Location Services</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/send-sms.md'>Send SMS</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-call.md'>GSM Call</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-signal.md'>GSM Signal</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-voice.md'>GSM Voice</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/performance-data'>Performance Data</a><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></li>
|
||||
<li><a href='/docs/en/commands/device/simulator'>Simulator</a><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></li>
|
||||
<li><a href='/docs/en/commands/device/system'>System</a><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></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/element'>Element</a><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>
|
||||
<li><a href='/docs/en/commands/element/actions'>Actions</a><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></li>
|
||||
<li><a href='/docs/en/commands/element/attributes'>Attributes</a><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>
|
||||
<li><a href='/docs/en/commands/element/attributes/attribute.md'>Attribute</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/selected.md'>Selected</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/enabled.md'>Enabled</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/enabled.md'>Displayed</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/location.md'>Location</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/size.md'>Size</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/rect.md'>Rect</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/css-property.md'>CSS Property</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/location-in-view.md'>Location in View</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/element/other'>Other</a><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></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/context'>Context</a><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></li>
|
||||
<li><a href='/docs/en/commands/interactions'>Interactions</a><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>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/doubleclick.md'>Double Click</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/button-down.md'>Button Down</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/button-up.md'>Button Up</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch'>Touch</a><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>
|
||||
<li><a href='/docs/en/commands/interactions/touch/move.md'>Move</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-down.md'>Touch Down</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-up.md'>Touch Up</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/long-press.md'>Long Press</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/scroll.md'>Scroll</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/flick.md'>Flick</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/multi-touch-perform.md'>Multi Touch Perform</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-perform.md'>Touch Perform</a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web'>Web</a><ul> <li><a href='/docs/en/commands/web/window'>Window</a><ul> <li><a href='/docs/en/commands/web/window/set-window.md'>Set Window</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/close-window.md'>Close Window</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-handle.md'>Get Handle</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-handles.md'>Get Handles</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/title.md'>Get Title</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-window-size.md'>Get Window Size</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/set-window-size.md'>Set Window Size</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-window-position.md'>Get Window Position</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/set-window-position.md'>Set Window Position</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/maximize-window.md'>Maximize Window</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/navigation'>Navigation</a><ul> <li><a href='/docs/en/commands/web/navigation/go-to-url.md'>Go to URL</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/url.md'>Get URL</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/back.md'>Back</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/forward.md'>Forward</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/refresh.md'>Refresh</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/storage'>Storage</a><ul> <li><a href='/docs/en/commands/web/storage/get-all-cookies.md'>Get All Cookies</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/set-cookie.md'>Set Cookie</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/delete-cookie.md'>Delete Cookie</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/delete-all-cookies.md'>Delete All Cookies</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/frame'>Frame</a><ul> <li><a href='/docs/en/commands/web/frame/switch.md'>Switch to Frame</a></li>
|
||||
<li><a href='/docs/en/commands/web/frame/parent.md'>Switch to Parent Frame</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/execute-async.md'>Execute Async</a></li>
|
||||
<li><a href='/docs/en/commands/web/execute.md'>Execute</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,14 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/context
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
@@ -51,7 +51,7 @@ $contexts = $driver->contexts();
|
||||
## 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).
|
||||
|
||||
On iOS, using the XCUITest driver, one can use the `mobile: getContexts` [mobile command](/docs/en/commands/mobile-command.md) as an alternative to the standard method in order to get the title and url associated with each context as additional metadata.
|
||||
For information on contexts, see Appium's [hybrid automation docs](/docs/en/writing-running-appium/web/hybrid.md).
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/device
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/device/activity/current-package.md'>Current Package</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/app'>App</a><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>
|
||||
<li><a href='/docs/en/commands/device/app/launch-app.md'>Launch App</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/background-app.md'>Background App</a></li>
|
||||
<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/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/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>
|
||||
<li><a href='/docs/en/commands/device/files/pull-folder.md'>Pull Folder</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/interactions'>Interactions</a><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>
|
||||
<li><a href='/docs/en/commands/device/interactions/unlock.md'>Unlock</a></li>
|
||||
<li><a href='/docs/en/commands/device/interactions/is-locked.md'>Is Locked</a></li>
|
||||
<li><a href='/docs/en/commands/device/interactions/rotate.md'>Rotate</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/keys'>Keys</a><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>
|
||||
<li><a href='/docs/en/commands/device/keys/hide-keyboard.md'>Hide Keyboard</a></li>
|
||||
<li><a href='/docs/en/commands/device/keys/is-keyboard-shown.md'>Is Keyboard Shown</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/network'>Network</a><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>
|
||||
<li><a href='/docs/en/commands/device/network/toggle-wifi.md'>Toggle WiFi</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/toggle-location-services.md'>Toggle Location Services</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/send-sms.md'>Send SMS</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-call.md'>GSM Call</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-signal.md'>GSM Signal</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-voice.md'>GSM Voice</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/device/performance-data'>Performance Data</a><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></li>
|
||||
<li><a href='/docs/en/commands/device/simulator'>Simulator</a><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></li>
|
||||
<li><a href='/docs/en/commands/device/system'>System</a><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></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,14 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/device/activity
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
@@ -0,0 +1,20 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/device/app
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/device/app/launch-app.md'>Launch App</a></li>
|
||||
<li><a href='/docs/en/commands/device/app/background-app.md'>Background App</a></li>
|
||||
<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/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>
|
||||
</div>
|
||||
@@ -0,0 +1,14 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/device/files
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
@@ -0,0 +1,16 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/device/interactions
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/device/interactions/unlock.md'>Unlock</a></li>
|
||||
<li><a href='/docs/en/commands/device/interactions/is-locked.md'>Is Locked</a></li>
|
||||
<li><a href='/docs/en/commands/device/interactions/rotate.md'>Rotate</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,15 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/device/keys
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/device/keys/hide-keyboard.md'>Hide Keyboard</a></li>
|
||||
<li><a href='/docs/en/commands/device/keys/is-keyboard-shown.md'>Is Keyboard Shown</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,19 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/device/network
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/device/network/toggle-wifi.md'>Toggle WiFi</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/toggle-location-services.md'>Toggle Location Services</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/send-sms.md'>Send SMS</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-call.md'>GSM Call</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-signal.md'>GSM Signal</a></li>
|
||||
<li><a href='/docs/en/commands/device/network/gsm-voice.md'>GSM Voice</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,13 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/device/performance-data
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
@@ -0,0 +1,13 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/device/simulator
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
@@ -0,0 +1,14 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/device/system
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
@@ -0,0 +1,33 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/element
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/element/actions'>Actions</a><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></li>
|
||||
<li><a href='/docs/en/commands/element/attributes'>Attributes</a><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>
|
||||
<li><a href='/docs/en/commands/element/attributes/attribute.md'>Attribute</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/selected.md'>Selected</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/enabled.md'>Enabled</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/enabled.md'>Displayed</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/location.md'>Location</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/size.md'>Size</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/rect.md'>Rect</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/css-property.md'>CSS Property</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/location-in-view.md'>Location in View</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/element/other'>Other</a><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></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,14 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/element/actions
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
@@ -0,0 +1,22 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/element/attributes
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/element/attributes/attribute.md'>Attribute</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/selected.md'>Selected</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/enabled.md'>Enabled</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/enabled.md'>Displayed</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/location.md'>Location</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/size.md'>Size</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/rect.md'>Rect</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/css-property.md'>CSS Property</a></li>
|
||||
<li><a href='/docs/en/commands/element/attributes/location-in-view.md'>Location in View</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,14 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/element/other
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
@@ -0,0 +1,28 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/interactions
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/doubleclick.md'>Double Click</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/button-down.md'>Button Down</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/button-up.md'>Button Up</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch'>Touch</a><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>
|
||||
<li><a href='/docs/en/commands/interactions/touch/move.md'>Move</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-down.md'>Touch Down</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-up.md'>Touch Up</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/long-press.md'>Long Press</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/scroll.md'>Scroll</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/flick.md'>Flick</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/multi-touch-perform.md'>Multi Touch Perform</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-perform.md'>Touch Perform</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,16 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/interactions/mouse
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/doubleclick.md'>Double Click</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/button-down.md'>Button Down</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/mouse/button-up.md'>Button Up</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,21 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/interactions/touch
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<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>
|
||||
<li><a href='/docs/en/commands/interactions/touch/move.md'>Move</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-down.md'>Touch Down</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-up.md'>Touch Up</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/long-press.md'>Long Press</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/scroll.md'>Scroll</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/flick.md'>Flick</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/multi-touch-perform.md'>Multi Touch Perform</a></li>
|
||||
<li><a href='/docs/en/commands/interactions/touch/touch-perform.md'>Touch Perform</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -53,6 +53,8 @@ await driver.execute('mobile: scroll', {direction: 'down'});
|
||||
Execute a variety of native, mobile commands that aren't associated with a specific endpoint
|
||||
|
||||
Syntax is `execute("mobile: <commandName>", <JSON serializable argument>)`
|
||||
(see [Execute Script](/docs/en/commands/web/execute.md) for more details
|
||||
on syntax).
|
||||
|
||||
List of available commands:
|
||||
|
||||
@@ -88,6 +90,7 @@ List of available commands:
|
||||
| mobile:setPasteboard | refer to [IOS Pasteboard Guide](/docs/en/writing-running-appium/ios/ios-xctest-pasteboard.md#mobile-setpasteboard) | | |
|
||||
| mobile:getPasteboard | refer to [IOS Pasteboard Guide](/docs/en/writing-running-appium/ios/ios-xctest-pasteboard.md#mobile-getpasteboard) | | |
|
||||
| mobile:installCertificate | refer to [IOS Pasteboard Guide](/docs/en/writing-running-appium/ios/ios-xctest-install-certificate.md) | | |
|
||||
| mobile:getContexts | Retrieve available contexts, along with the url and title associated with each webview (see [get contexts](/docs/en/commands/context/get-contexts.md)) | | |
|
||||
|
||||
### Android
|
||||
| Command | Description | Argument | Argument Example |
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/session
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/session/create.md'>Create</a></li>
|
||||
<li><a href='/docs/en/commands/session/delete.md'>End</a></li>
|
||||
<li><a href='/docs/en/commands/session/get.md'>Get Session Capabilities</a></li>
|
||||
<li><a href='/docs/en/commands/session/back.md'>Go Back</a></li>
|
||||
<li><a href='/docs/en/commands/session/screenshot.md'>Screenshot</a></li>
|
||||
<li><a href='/docs/en/commands/session/source.md'>Source</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts'>Timeouts</a><ul> <li><a href='/docs/en/commands/session/timeouts/timeouts.md'>Timeouts</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts/implicit-wait.md'>Implicit Wait</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts/async-script.md'>Async Script</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/orientation'>Orientation</a><ul> <li><a href='/docs/en/commands/session/orientation/get-orientation.md'>Get Orientation</a></li>
|
||||
<li><a href='/docs/en/commands/session/orientation/set-orientation.md'>Set Orientation</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/geolocation'>Geolocation</a><ul> <li><a href='/docs/en/commands/session/geolocation/get-geolocation.md'>Get Geolocation</a></li>
|
||||
<li><a href='/docs/en/commands/session/geolocation/set-geolocation.md'>Set Geolocation</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/logs'>Logs</a><ul> <li><a href='/docs/en/commands/session/logs/get-log-types.md'>Get Log Types</a></li>
|
||||
<li><a href='/docs/en/commands/session/logs/get-log.md'>Get Logs</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/session/settings'>Settings</a><ul> <li><a href='/docs/en/commands/session/settings/update-settings.md'>Update Settings</a></li>
|
||||
<li><a href='/docs/en/commands/session/settings/get-settings.md'>Get Device Settings</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,13 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/session/geolocation
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/session/geolocation/get-geolocation.md'>Get Geolocation</a></li>
|
||||
<li><a href='/docs/en/commands/session/geolocation/set-geolocation.md'>Set Geolocation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,13 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/session/logs
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/session/logs/get-log-types.md'>Get Log Types</a></li>
|
||||
<li><a href='/docs/en/commands/session/logs/get-log.md'>Get Logs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,13 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/session/orientation
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/session/orientation/get-orientation.md'>Get Orientation</a></li>
|
||||
<li><a href='/docs/en/commands/session/orientation/set-orientation.md'>Set Orientation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,13 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/session/settings
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/session/settings/update-settings.md'>Update Settings</a></li>
|
||||
<li><a href='/docs/en/commands/session/settings/get-settings.md'>Get Device Settings</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,14 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/session/timeouts
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/session/timeouts/timeouts.md'>Timeouts</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts/implicit-wait.md'>Implicit Wait</a></li>
|
||||
<li><a href='/docs/en/commands/session/timeouts/async-script.md'>Async Script</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,38 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/web
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/web/window'>Window</a><ul> <li><a href='/docs/en/commands/web/window/set-window.md'>Set Window</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/close-window.md'>Close Window</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-handle.md'>Get Handle</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-handles.md'>Get Handles</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/title.md'>Get Title</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-window-size.md'>Get Window Size</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/set-window-size.md'>Set Window Size</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-window-position.md'>Get Window Position</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/set-window-position.md'>Set Window Position</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/maximize-window.md'>Maximize Window</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/navigation'>Navigation</a><ul> <li><a href='/docs/en/commands/web/navigation/go-to-url.md'>Go to URL</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/url.md'>Get URL</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/back.md'>Back</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/forward.md'>Forward</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/refresh.md'>Refresh</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/storage'>Storage</a><ul> <li><a href='/docs/en/commands/web/storage/get-all-cookies.md'>Get All Cookies</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/set-cookie.md'>Set Cookie</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/delete-cookie.md'>Delete Cookie</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/delete-all-cookies.md'>Delete All Cookies</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/frame'>Frame</a><ul> <li><a href='/docs/en/commands/web/frame/switch.md'>Switch to Frame</a></li>
|
||||
<li><a href='/docs/en/commands/web/frame/parent.md'>Switch to Parent Frame</a></li>
|
||||
</ul></li>
|
||||
<li><a href='/docs/en/commands/web/execute-async.md'>Execute Async</a></li>
|
||||
<li><a href='/docs/en/commands/web/execute.md'>Execute</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -62,6 +62,8 @@ The script argument defines the script to execute in the form of a function body
|
||||
|
||||
Arguments may be any JSON-primitive, array, or JSON object. JSON objects that define a WebElement reference will be converted to the corresponding DOM element. Likewise, any WebElements in the script result will be returned to the client as WebElement JSON objects.
|
||||
|
||||
For `execute` in the native context, see [Mobile Commands](/docs/en/commands/mobile-command.md).
|
||||
|
||||
|
||||
## Support
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/web/frame
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/web/frame/switch.md'>Switch to Frame</a></li>
|
||||
<li><a href='/docs/en/commands/web/frame/parent.md'>Switch to Parent Frame</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,16 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/web/navigation
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/web/navigation/go-to-url.md'>Go to URL</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/url.md'>Get URL</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/back.md'>Back</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/forward.md'>Forward</a></li>
|
||||
<li><a href='/docs/en/commands/web/navigation/refresh.md'>Refresh</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,15 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/web/storage
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/web/storage/get-all-cookies.md'>Get All Cookies</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/set-cookie.md'>Set Cookie</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/delete-cookie.md'>Delete Cookie</a></li>
|
||||
<li><a href='/docs/en/commands/web/storage/delete-all-cookies.md'>Delete All Cookies</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -0,0 +1,21 @@
|
||||
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file.)
|
||||
|
||||
## Appium API Documentation
|
||||
|
||||
### /docs/en/commands/web/window
|
||||
|
||||
<div class="api-index">
|
||||
|
||||
<ul>
|
||||
<li><a href='/docs/en/commands/web/window/set-window.md'>Set Window</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/close-window.md'>Close Window</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-handle.md'>Get Handle</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-handles.md'>Get Handles</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/title.md'>Get Title</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-window-size.md'>Get Window Size</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/set-window-size.md'>Set Window Size</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/get-window-position.md'>Get Window Position</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/set-window-position.md'>Set Window Position</a></li>
|
||||
<li><a href='/docs/en/commands/web/window/maximize-window.md'>Maximize Window</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
Reference in New Issue
Block a user