@wdio/protocols 9.14.0 → 9.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/commands/appium.d.ts +54 -5
- package/build/commands/appium.d.ts.map +1 -1
- package/build/index.js +1726 -1689
- package/build/protocols/appium.d.ts +81 -20
- package/build/protocols/appium.d.ts.map +1 -1
- package/package.json +2 -2
package/build/index.js
CHANGED
|
@@ -2478,607 +2478,683 @@ var mjsonwp_default = {
|
|
|
2478
2478
|
}
|
|
2479
2479
|
};
|
|
2480
2480
|
|
|
2481
|
-
// src/protocols/
|
|
2482
|
-
var
|
|
2483
|
-
"/session/:sessionId/
|
|
2481
|
+
// src/protocols/chromium.ts
|
|
2482
|
+
var chromium_default = {
|
|
2483
|
+
"/session/:sessionId/alert": {
|
|
2484
2484
|
GET: {
|
|
2485
|
-
command: "
|
|
2486
|
-
|
|
2485
|
+
command: "isAlertOpen",
|
|
2486
|
+
description: "Whether a simple dialog is currently open.",
|
|
2487
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/alert_commands.cc#L42-L49",
|
|
2488
|
+
examples: [
|
|
2489
|
+
[
|
|
2490
|
+
"console.log(browser.isAlertOpen()); // outputs: false",
|
|
2491
|
+
"browser.execute('window.alert()');",
|
|
2492
|
+
"console.log(browser.isAlertOpen()); // outputs: true"
|
|
2493
|
+
]
|
|
2494
|
+
],
|
|
2487
2495
|
parameters: [],
|
|
2488
2496
|
returns: {
|
|
2489
|
-
type: "
|
|
2490
|
-
name: "
|
|
2491
|
-
description: "
|
|
2497
|
+
type: "Boolean",
|
|
2498
|
+
name: "isAlertOpen",
|
|
2499
|
+
description: "`true` or `false` based on whether simple dialog is present or not."
|
|
2500
|
+
}
|
|
2501
|
+
}
|
|
2502
|
+
},
|
|
2503
|
+
"/session/:sessionId/autoreport": {
|
|
2504
|
+
GET: {
|
|
2505
|
+
command: "isAutoReporting",
|
|
2506
|
+
description: "Whether it should automatically raises errors on browser logs.",
|
|
2507
|
+
ref: "https://codereview.chromium.org/101203012",
|
|
2508
|
+
parameters: [],
|
|
2509
|
+
returns: {
|
|
2510
|
+
type: "Boolean",
|
|
2511
|
+
name: "isAutoReporting",
|
|
2512
|
+
description: "`true` or `false` based on whether auto reporting is enabled."
|
|
2492
2513
|
}
|
|
2493
2514
|
},
|
|
2494
2515
|
POST: {
|
|
2495
|
-
command: "
|
|
2496
|
-
|
|
2516
|
+
command: "setAutoReporting",
|
|
2517
|
+
description: "Toggle whether to return response with unknown error with first browser error (e.g. failed to load resource due to 403/404 response) for all subsequent commands (once enabled).",
|
|
2518
|
+
ref: "https://codereview.chromium.org/101203012",
|
|
2519
|
+
examples: [
|
|
2520
|
+
[
|
|
2521
|
+
"// Enable auto reporting first thing after session was initiated with empty browser logs",
|
|
2522
|
+
"console.log(browser.setAutoReporting(true)); // outputs: null",
|
|
2523
|
+
"// Upon requesting an non-existing resource it will abort execution due to thrown unknown error",
|
|
2524
|
+
"browser.url('https://webdriver.io/img/404-does-not-exist.png');"
|
|
2525
|
+
],
|
|
2526
|
+
[
|
|
2527
|
+
"// During the session do some operations which populate the browser logs",
|
|
2528
|
+
"browser.url('https://webdriver.io/img/404-does-not-exist.png');",
|
|
2529
|
+
"browser.url('https://webdriver.io/403/no-access');",
|
|
2530
|
+
"// Enable auto reporting which throws an unknown error for first browser log (404 response)",
|
|
2531
|
+
"browser.setAutoReporting(true);"
|
|
2532
|
+
]
|
|
2533
|
+
],
|
|
2497
2534
|
parameters: [
|
|
2498
2535
|
{
|
|
2499
|
-
name: "
|
|
2500
|
-
type: "
|
|
2501
|
-
description: "
|
|
2536
|
+
name: "enabled",
|
|
2537
|
+
type: "boolean",
|
|
2538
|
+
description: "`true` if auto reporting should be enabled, use `false` to disable previously enabled auto reporting.",
|
|
2502
2539
|
required: true
|
|
2503
2540
|
}
|
|
2504
|
-
]
|
|
2541
|
+
],
|
|
2542
|
+
returns: {
|
|
2543
|
+
type: "Object|Null",
|
|
2544
|
+
name: "firstBrowserError",
|
|
2545
|
+
description: "In case first browser error already occured prior to executing this command it will throw unknown error as response, which is an object with 'message' key describing first browser error. Otherwise it returns `null` on success."
|
|
2546
|
+
}
|
|
2505
2547
|
}
|
|
2506
2548
|
},
|
|
2507
|
-
"/session/:sessionId/
|
|
2549
|
+
"/session/:sessionId/is_loading": {
|
|
2508
2550
|
GET: {
|
|
2509
|
-
command: "
|
|
2510
|
-
|
|
2551
|
+
command: "isLoading",
|
|
2552
|
+
description: "Determines load status for active window handle.",
|
|
2553
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L783-L802",
|
|
2554
|
+
examples: [
|
|
2555
|
+
[
|
|
2556
|
+
"console.log(browser.isLoading()); // outputs: false",
|
|
2557
|
+
"browser.newWindow('https://webdriver.io');",
|
|
2558
|
+
"console.log(browser.isLoading()); // outputs: true"
|
|
2559
|
+
]
|
|
2560
|
+
],
|
|
2511
2561
|
parameters: [],
|
|
2512
2562
|
returns: {
|
|
2513
|
-
type: "
|
|
2514
|
-
name: "
|
|
2515
|
-
description: "
|
|
2563
|
+
type: "Boolean",
|
|
2564
|
+
name: "isLoading",
|
|
2565
|
+
description: "`true` or `false` based on whether active window handle is loading or not."
|
|
2516
2566
|
}
|
|
2517
2567
|
}
|
|
2518
2568
|
},
|
|
2519
|
-
"/session/:sessionId/
|
|
2520
|
-
|
|
2521
|
-
command: "
|
|
2522
|
-
description: "
|
|
2523
|
-
ref: "https://
|
|
2569
|
+
"/session/:sessionId/chromium/heap_snapshot": {
|
|
2570
|
+
GET: {
|
|
2571
|
+
command: "takeHeapSnapshot",
|
|
2572
|
+
description: "Takes a heap snapshot of the current execution context.",
|
|
2573
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/chrome/web_view.h#L198-L202",
|
|
2524
2574
|
parameters: [],
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
|
|
2529
|
-
}
|
|
2575
|
+
returns: {
|
|
2576
|
+
type: "Object",
|
|
2577
|
+
name: "heapSnapshot",
|
|
2578
|
+
description: "A JSON representation of the heap snapshot. Which can be inspected by loading as file into Chrome DevTools."
|
|
2530
2579
|
}
|
|
2531
2580
|
}
|
|
2532
2581
|
},
|
|
2533
|
-
"/session/:sessionId/
|
|
2582
|
+
"/session/:sessionId/network_connection": {
|
|
2583
|
+
GET: {
|
|
2584
|
+
command: "getNetworkConnection",
|
|
2585
|
+
description: "Get the connection type for network emulation. This command is only applicable when remote end replies with `networkConnectionEnabled` capability set to `true`.",
|
|
2586
|
+
ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes",
|
|
2587
|
+
examples: [
|
|
2588
|
+
[
|
|
2589
|
+
"const browser = remote({",
|
|
2590
|
+
" capabilities: {",
|
|
2591
|
+
" browserName: 'chrome',",
|
|
2592
|
+
" 'goog:chromeOptions': {",
|
|
2593
|
+
" // Network emulation requires device mode, which is only enabled when mobile emulation is on",
|
|
2594
|
+
" mobileEmulation: { deviceName: 'iPad' },",
|
|
2595
|
+
" },",
|
|
2596
|
+
" }",
|
|
2597
|
+
"});",
|
|
2598
|
+
"console.log(browser.getNetworkConnection()); // outputs: 6 (Both Wi-Fi and data)"
|
|
2599
|
+
]
|
|
2600
|
+
],
|
|
2601
|
+
parameters: [],
|
|
2602
|
+
returns: {
|
|
2603
|
+
type: "Number",
|
|
2604
|
+
name: "connectionType",
|
|
2605
|
+
description: "A bitmask to represent the network connection type. Airplane Mode (`1`), Wi-Fi only (`2`), Wi-Fi and data (`6`), 4G (`8`), 3G (`10`), 2G (`20`). By default [Wi-Fi and data are enabled](https://github.com/bayandin/chromedriver/blob/v2.45/chrome/chrome_desktop_impl.cc#L36-L37)."
|
|
2606
|
+
}
|
|
2607
|
+
},
|
|
2534
2608
|
POST: {
|
|
2535
|
-
command: "
|
|
2536
|
-
description: "
|
|
2537
|
-
ref: "https://
|
|
2609
|
+
command: "setNetworkConnection",
|
|
2610
|
+
description: "Change connection type for network connection. This command is only applicable when remote end replies with `networkConnectionEnabled` capability set to `true`.",
|
|
2611
|
+
ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes",
|
|
2612
|
+
examples: [
|
|
2613
|
+
[
|
|
2614
|
+
"const browser = remote({",
|
|
2615
|
+
" capabilities: {",
|
|
2616
|
+
" browserName: 'chrome',",
|
|
2617
|
+
" 'goog:chromeOptions': {",
|
|
2618
|
+
" // Network emulation requires device mode, which is only enabled when mobile emulation is on",
|
|
2619
|
+
" mobileEmulation: { deviceName: 'iPad' },",
|
|
2620
|
+
" },",
|
|
2621
|
+
" }",
|
|
2622
|
+
"});",
|
|
2623
|
+
"console.log(browser.setNetworkConnection({ type: 1 })); // outputs: 1 (Airplane Mode)"
|
|
2624
|
+
]
|
|
2625
|
+
],
|
|
2538
2626
|
parameters: [
|
|
2539
2627
|
{
|
|
2540
|
-
name: "
|
|
2541
|
-
type: "
|
|
2542
|
-
description: "
|
|
2543
|
-
required:
|
|
2628
|
+
name: "parameters",
|
|
2629
|
+
type: "object",
|
|
2630
|
+
description: "Object containing ConnectionType, set bitmask as value for `type` key in object. Airplane Mode (`1`), Wi-Fi only (`2`), Wi-Fi and data (`6`), 4G (`8`), 3G (`10`), 2G (`20`).",
|
|
2631
|
+
required: true
|
|
2544
2632
|
}
|
|
2545
2633
|
],
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
|
-
|
|
2550
|
-
android: {
|
|
2551
|
-
UiAutomator: "4.2+"
|
|
2552
|
-
},
|
|
2553
|
-
windows: {
|
|
2554
|
-
Windows: "10+"
|
|
2555
|
-
}
|
|
2634
|
+
returns: {
|
|
2635
|
+
type: "Number",
|
|
2636
|
+
name: "connectionType",
|
|
2637
|
+
description: "A bitmask to represent the network connection type. Value should match specified `type` in object, however device might not be capable of the network connection type requested."
|
|
2556
2638
|
}
|
|
2557
2639
|
}
|
|
2558
2640
|
},
|
|
2559
|
-
"/session/:sessionId/
|
|
2560
|
-
|
|
2561
|
-
command: "
|
|
2562
|
-
description: "
|
|
2563
|
-
ref: "https://
|
|
2641
|
+
"/session/:sessionId/chromium/network_conditions": {
|
|
2642
|
+
GET: {
|
|
2643
|
+
command: "getNetworkConditions",
|
|
2644
|
+
description: "Get current network conditions used for emulation.",
|
|
2645
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L839-L859",
|
|
2564
2646
|
parameters: [],
|
|
2565
|
-
|
|
2566
|
-
|
|
2567
|
-
|
|
2647
|
+
returns: {
|
|
2648
|
+
type: "Object",
|
|
2649
|
+
name: "networkConditions",
|
|
2650
|
+
description: "Object containing network conditions for `offline`, `latency`, `download_throughput` and `upload_throughput`. Network conditions must be set before it can be retrieved."
|
|
2651
|
+
}
|
|
2652
|
+
},
|
|
2653
|
+
POST: {
|
|
2654
|
+
command: "setNetworkConditions",
|
|
2655
|
+
description: "Set network conditions used for emulation by throttling connection.",
|
|
2656
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1663-L1722",
|
|
2657
|
+
examples: [
|
|
2658
|
+
[
|
|
2659
|
+
"// Use different download (25kb/s) and upload (50kb/s) throughput values for throttling with a latency of 1000ms",
|
|
2660
|
+
"browser.setNetworkConditions({ latency: 1000, download_throughput: 25600, upload_throughput: 51200 });"
|
|
2661
|
+
],
|
|
2662
|
+
[
|
|
2663
|
+
"// Force disconnected from network by setting 'offline' to true",
|
|
2664
|
+
"browser.setNetworkConditions({ latency: 0, throughput: 0, offline: true });"
|
|
2665
|
+
],
|
|
2666
|
+
[
|
|
2667
|
+
"// When preset name (e.g. 'DSL') is specified it does not respect values in object (e.g. 'offline')",
|
|
2668
|
+
"browser.setNetworkConditions({ latency: 0, throughput: 0, offline: true }, 'DSL');"
|
|
2669
|
+
],
|
|
2670
|
+
[
|
|
2671
|
+
"// Best practice for specifying network throttling preset is to use an empty object",
|
|
2672
|
+
"browser.setNetworkConditions({}, 'Good 3G');"
|
|
2673
|
+
]
|
|
2674
|
+
],
|
|
2675
|
+
parameters: [
|
|
2676
|
+
{
|
|
2677
|
+
name: "network_conditions",
|
|
2678
|
+
type: "object",
|
|
2679
|
+
description: "Object containing network conditions which are `latency`, `throughput` (or `download_throughput`/`upload_throughput`) and `offline` (optional).",
|
|
2680
|
+
required: true
|
|
2568
2681
|
},
|
|
2569
|
-
|
|
2570
|
-
|
|
2682
|
+
{
|
|
2683
|
+
name: "network_name",
|
|
2684
|
+
type: "string",
|
|
2685
|
+
description: "Name of [network throttling preset](https://github.com/bayandin/chromedriver/blob/v2.45/chrome/network_list.cc#L12-L25). `GPRS`, `Regular 2G`, `Good 2G`, `Regular 3G`, `Good 3G`, `Regular 4G`, `DSL`, `WiFi` or `No throttling` to disable. When preset is specified values passed in first argument are not respected.",
|
|
2686
|
+
required: false
|
|
2571
2687
|
}
|
|
2572
|
-
|
|
2688
|
+
]
|
|
2689
|
+
},
|
|
2690
|
+
DELETE: {
|
|
2691
|
+
command: "deleteNetworkConditions",
|
|
2692
|
+
description: "Disable any network throttling which might have been set. Equivalent of setting the `No throttling` preset.",
|
|
2693
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1724-L1745",
|
|
2694
|
+
parameters: []
|
|
2573
2695
|
}
|
|
2574
2696
|
},
|
|
2575
|
-
"/session/:sessionId/
|
|
2697
|
+
"/session/:sessionId/chromium/send_command": {
|
|
2576
2698
|
POST: {
|
|
2577
|
-
command: "
|
|
2578
|
-
description: "
|
|
2579
|
-
ref: "https://
|
|
2580
|
-
parameters: [
|
|
2581
|
-
|
|
2582
|
-
|
|
2583
|
-
|
|
2584
|
-
|
|
2585
|
-
|
|
2586
|
-
support: {
|
|
2587
|
-
android: {
|
|
2588
|
-
UiAutomator: "4.2+"
|
|
2699
|
+
command: "sendCommand",
|
|
2700
|
+
description: "Send a command to the DevTools debugger.<br />For a list of available commands and their parameters refer to the [Chrome DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).",
|
|
2701
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1290-L1304",
|
|
2702
|
+
parameters: [
|
|
2703
|
+
{
|
|
2704
|
+
name: "cmd",
|
|
2705
|
+
type: "string",
|
|
2706
|
+
description: "Name of the command (e.g. [`Browser.close`](https://chromedevtools.github.io/devtools-protocol/1-3/Browser#method-close)).",
|
|
2707
|
+
required: true
|
|
2589
2708
|
},
|
|
2590
|
-
|
|
2591
|
-
|
|
2709
|
+
{
|
|
2710
|
+
name: "params",
|
|
2711
|
+
type: "object",
|
|
2712
|
+
description: "Parameters to the command. In case no parameters for command, specify an empty object.",
|
|
2713
|
+
required: true
|
|
2592
2714
|
}
|
|
2593
|
-
|
|
2715
|
+
]
|
|
2594
2716
|
}
|
|
2595
2717
|
},
|
|
2596
|
-
"/session/:sessionId/
|
|
2718
|
+
"/session/:sessionId/chromium/send_command_and_get_result": {
|
|
2597
2719
|
POST: {
|
|
2598
|
-
command: "
|
|
2599
|
-
description: "
|
|
2600
|
-
ref: "https://
|
|
2720
|
+
command: "sendCommandAndGetResult",
|
|
2721
|
+
description: "Send a command to the DevTools debugger and wait for the result.<br />For a list of available commands and their parameters refer to the [Chrome DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).",
|
|
2722
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1306-L1320",
|
|
2601
2723
|
parameters: [
|
|
2602
2724
|
{
|
|
2603
|
-
name: "
|
|
2604
|
-
type: "
|
|
2605
|
-
description: "
|
|
2606
|
-
required:
|
|
2607
|
-
}
|
|
2608
|
-
],
|
|
2609
|
-
support: {
|
|
2610
|
-
ios: {
|
|
2611
|
-
XCUITest: "9.3+"
|
|
2612
|
-
},
|
|
2613
|
-
android: {
|
|
2614
|
-
UiAutomator: "4.2+"
|
|
2725
|
+
name: "cmd",
|
|
2726
|
+
type: "string",
|
|
2727
|
+
description: "Name of the command which returns a result (e.g. [`Network.getAllCookies`](https://chromedevtools.github.io/devtools-protocol/1-3/Network#method-getAllCookies)).",
|
|
2728
|
+
required: true
|
|
2615
2729
|
},
|
|
2616
|
-
|
|
2617
|
-
|
|
2730
|
+
{
|
|
2731
|
+
name: "params",
|
|
2732
|
+
type: "object",
|
|
2733
|
+
description: "Parameters to the command. In case no parameters for command, specify an empty object.",
|
|
2734
|
+
required: true
|
|
2618
2735
|
}
|
|
2736
|
+
],
|
|
2737
|
+
returns: {
|
|
2738
|
+
type: "*",
|
|
2739
|
+
name: "result",
|
|
2740
|
+
description: "Either the return value of your command, or the error which was the reason for your command's failure."
|
|
2619
2741
|
}
|
|
2620
2742
|
}
|
|
2621
2743
|
},
|
|
2622
|
-
"/session/:sessionId/
|
|
2744
|
+
"/session/:sessionId/file": {
|
|
2623
2745
|
POST: {
|
|
2624
|
-
command: "
|
|
2625
|
-
description: "
|
|
2626
|
-
ref: "https://
|
|
2746
|
+
command: "file",
|
|
2747
|
+
description: "Upload a file to remote machine on which the browser is running.",
|
|
2748
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L1037-L1065",
|
|
2627
2749
|
parameters: [
|
|
2628
2750
|
{
|
|
2629
|
-
name: "
|
|
2630
|
-
type: "string",
|
|
2631
|
-
description: "The path to the remote location, where the resulting video should be uploaded. The following protocols are supported http/https, ftp. This option only has an effect if there is screen recording process in progreess and forceRestart parameter is not set to true. Null or empty string value (the default setting) means the content of resulting file should be encoded as Base64.",
|
|
2632
|
-
required: false
|
|
2633
|
-
},
|
|
2634
|
-
{
|
|
2635
|
-
name: "username",
|
|
2751
|
+
name: "file",
|
|
2636
2752
|
type: "string",
|
|
2637
|
-
description: "
|
|
2638
|
-
required:
|
|
2639
|
-
}
|
|
2753
|
+
description: "Base64-encoded zip archive containing __single__ file which to upload. In case base64-encoded data does not represent a zip archive or archive contains more than one file it will throw an unknown error.",
|
|
2754
|
+
required: true
|
|
2755
|
+
}
|
|
2756
|
+
],
|
|
2757
|
+
returns: {
|
|
2758
|
+
type: "String",
|
|
2759
|
+
name: "path",
|
|
2760
|
+
description: "Absolute path of uploaded file on remote machine."
|
|
2761
|
+
}
|
|
2762
|
+
}
|
|
2763
|
+
},
|
|
2764
|
+
"/session/:sessionId/chromium/launch_app": {
|
|
2765
|
+
POST: {
|
|
2766
|
+
command: "launchChromeApp",
|
|
2767
|
+
description: "Launches a Chrome app by specified id.",
|
|
2768
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L521-L539",
|
|
2769
|
+
examples: [
|
|
2770
|
+
[
|
|
2771
|
+
"import fs from 'fs'",
|
|
2772
|
+
"const browser = remote({",
|
|
2773
|
+
" capabilities: {",
|
|
2774
|
+
" browserName: 'chrome',",
|
|
2775
|
+
" 'goog:chromeOptions': {",
|
|
2776
|
+
" // Install upon starting browser in order to launch it",
|
|
2777
|
+
" extensions: [",
|
|
2778
|
+
" // Entry should be a base64-encoded packed Chrome app (.crx)",
|
|
2779
|
+
" fs.readFileSync('/absolute/path/app.crx').toString('base64')",
|
|
2780
|
+
" ]",
|
|
2781
|
+
" }",
|
|
2782
|
+
" }",
|
|
2783
|
+
"});",
|
|
2784
|
+
"browser.launchChromeApp('aohghmighlieiainnegkcijnfilokake')); // Google Docs (https://chrome.google.com/webstore/detail/docs/aohghmighlieiainnegkcijnfilokake)"
|
|
2785
|
+
]
|
|
2786
|
+
],
|
|
2787
|
+
parameters: [
|
|
2640
2788
|
{
|
|
2641
|
-
name: "
|
|
2789
|
+
name: "id",
|
|
2642
2790
|
type: "string",
|
|
2643
|
-
description: "
|
|
2644
|
-
required:
|
|
2645
|
-
}
|
|
2791
|
+
description: "Extension id of app to be launched, as defined in chrome://extensions.",
|
|
2792
|
+
required: true
|
|
2793
|
+
}
|
|
2794
|
+
]
|
|
2795
|
+
}
|
|
2796
|
+
},
|
|
2797
|
+
"/session/:sessionId/element/:elementId/value": {
|
|
2798
|
+
GET: {
|
|
2799
|
+
command: "getElementValue",
|
|
2800
|
+
description: "Retrieves the value of a given form control element.",
|
|
2801
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/element_commands.cc#L431-L443",
|
|
2802
|
+
variables: [
|
|
2646
2803
|
{
|
|
2647
|
-
name: "
|
|
2648
|
-
|
|
2649
|
-
description: "The http multipart upload method name. The 'PUT' one is used by default.",
|
|
2650
|
-
required: false
|
|
2804
|
+
name: "elementId",
|
|
2805
|
+
description: "id of element to get value from"
|
|
2651
2806
|
}
|
|
2652
2807
|
],
|
|
2808
|
+
parameters: [],
|
|
2653
2809
|
returns: {
|
|
2654
|
-
type: "
|
|
2655
|
-
name: "
|
|
2656
|
-
description: "
|
|
2657
|
-
},
|
|
2658
|
-
support: {
|
|
2659
|
-
ios: {
|
|
2660
|
-
XCUITest: "9.3+"
|
|
2661
|
-
},
|
|
2662
|
-
android: {
|
|
2663
|
-
UiAutomator: "4.2+"
|
|
2664
|
-
},
|
|
2665
|
-
windows: {
|
|
2666
|
-
Windows: "10+"
|
|
2667
|
-
}
|
|
2810
|
+
type: "String|Null",
|
|
2811
|
+
name: "value",
|
|
2812
|
+
description: "Current value of the element. In case specified element is not a form control element, it will return `null`."
|
|
2668
2813
|
}
|
|
2669
2814
|
}
|
|
2670
2815
|
},
|
|
2671
|
-
"/session/:sessionId/
|
|
2816
|
+
"/session/:sessionId/element/:elementId/hover": {
|
|
2672
2817
|
POST: {
|
|
2673
|
-
command: "
|
|
2674
|
-
description: "
|
|
2675
|
-
ref: "https://
|
|
2676
|
-
|
|
2677
|
-
|
|
2678
|
-
|
|
2679
|
-
|
|
2680
|
-
description: "The available performance data types (cpuinfo|batteryinfo|networkinfo|memoryinfo)"
|
|
2681
|
-
},
|
|
2682
|
-
support: {
|
|
2683
|
-
android: {
|
|
2684
|
-
UiAutomator: "4.2+"
|
|
2818
|
+
command: "elementHover",
|
|
2819
|
+
description: "Enable hover state for an element, which is reset upon next interaction.",
|
|
2820
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/element_commands.cc#L126-L146",
|
|
2821
|
+
variables: [
|
|
2822
|
+
{
|
|
2823
|
+
name: "elementId",
|
|
2824
|
+
description: "id of element to hover over to"
|
|
2685
2825
|
}
|
|
2686
|
-
|
|
2826
|
+
],
|
|
2827
|
+
parameters: []
|
|
2687
2828
|
}
|
|
2688
2829
|
},
|
|
2689
|
-
"/session/:sessionId/
|
|
2830
|
+
"/session/:sessionId/touch/pinch": {
|
|
2690
2831
|
POST: {
|
|
2691
|
-
command: "
|
|
2692
|
-
description: "
|
|
2693
|
-
ref: "https://
|
|
2832
|
+
command: "touchPinch",
|
|
2833
|
+
description: "Trigger a pinch zoom effect.",
|
|
2834
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L813-L827",
|
|
2694
2835
|
parameters: [
|
|
2695
2836
|
{
|
|
2696
|
-
name: "
|
|
2697
|
-
type: "
|
|
2698
|
-
description: "
|
|
2837
|
+
name: "x",
|
|
2838
|
+
type: "number",
|
|
2839
|
+
description: "x position to pinch on",
|
|
2699
2840
|
required: true
|
|
2700
2841
|
},
|
|
2701
2842
|
{
|
|
2702
|
-
name: "
|
|
2703
|
-
type: "
|
|
2704
|
-
description: "
|
|
2843
|
+
name: "y",
|
|
2844
|
+
type: "number",
|
|
2845
|
+
description: "y position to pinch on",
|
|
2705
2846
|
required: true
|
|
2706
2847
|
},
|
|
2707
2848
|
{
|
|
2708
|
-
name: "
|
|
2849
|
+
name: "scale",
|
|
2709
2850
|
type: "number",
|
|
2710
|
-
description: "
|
|
2711
|
-
required:
|
|
2851
|
+
description: "pinch zoom scale",
|
|
2852
|
+
required: true
|
|
2712
2853
|
}
|
|
2713
|
-
]
|
|
2854
|
+
]
|
|
2855
|
+
}
|
|
2856
|
+
},
|
|
2857
|
+
"/session/:sessionId/goog/page/freeze": {
|
|
2858
|
+
POST: {
|
|
2859
|
+
command: "freeze",
|
|
2860
|
+
description: "Freeze the current page. Extension for [Page Lifecycle API](https://developers.google.com/web/updates/2018/07/page-lifecycle-api).",
|
|
2861
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L625-L633",
|
|
2862
|
+
parameters: []
|
|
2863
|
+
}
|
|
2864
|
+
},
|
|
2865
|
+
"/session/:sessionId/goog/page/resume": {
|
|
2866
|
+
POST: {
|
|
2867
|
+
command: "resume",
|
|
2868
|
+
description: "Resume the current page. Extension for [Page Lifecycle API](https://developers.google.com/web/updates/2018/07/page-lifecycle-api).",
|
|
2869
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L635-L645",
|
|
2870
|
+
parameters: []
|
|
2871
|
+
}
|
|
2872
|
+
},
|
|
2873
|
+
"/session/:sessionId/goog/cast/get_sinks": {
|
|
2874
|
+
GET: {
|
|
2875
|
+
command: "getCastSinks",
|
|
2876
|
+
description: "Returns the list of cast sinks (Cast devices) available to the Chrome media router.",
|
|
2877
|
+
ref: "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#748",
|
|
2878
|
+
parameters: [],
|
|
2714
2879
|
returns: {
|
|
2715
2880
|
type: "string[]",
|
|
2716
|
-
name: "
|
|
2717
|
-
description: "
|
|
2718
|
-
},
|
|
2719
|
-
support: {
|
|
2720
|
-
android: {
|
|
2721
|
-
UiAutomator: "4.2+"
|
|
2722
|
-
}
|
|
2881
|
+
name: "sinks",
|
|
2882
|
+
description: "List of available sinks."
|
|
2723
2883
|
}
|
|
2724
2884
|
}
|
|
2725
2885
|
},
|
|
2726
|
-
"/session/:sessionId/
|
|
2886
|
+
"/session/:sessionId/goog/cast/set_sink_to_use": {
|
|
2727
2887
|
POST: {
|
|
2728
|
-
command: "
|
|
2729
|
-
description: "
|
|
2730
|
-
ref: "https://
|
|
2888
|
+
command: "selectCastSink",
|
|
2889
|
+
description: "Selects a cast sink (Cast device) as the recipient of media router intents (connect or play).",
|
|
2890
|
+
ref: "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#737",
|
|
2731
2891
|
parameters: [
|
|
2732
2892
|
{
|
|
2733
|
-
name: "
|
|
2734
|
-
type: "
|
|
2735
|
-
description: "
|
|
2893
|
+
name: "sinkName",
|
|
2894
|
+
type: "string",
|
|
2895
|
+
description: "The name of the target device.",
|
|
2736
2896
|
required: true
|
|
2737
|
-
},
|
|
2738
|
-
{
|
|
2739
|
-
name: "metastate",
|
|
2740
|
-
type: "number",
|
|
2741
|
-
description: "meta state to press the keycode with",
|
|
2742
|
-
required: false
|
|
2743
|
-
},
|
|
2744
|
-
{
|
|
2745
|
-
name: "flags",
|
|
2746
|
-
type: "number",
|
|
2747
|
-
description: "flags for the keypress",
|
|
2748
|
-
required: false
|
|
2749
|
-
}
|
|
2750
|
-
],
|
|
2751
|
-
support: {
|
|
2752
|
-
android: {
|
|
2753
|
-
UiAutomator: "4.2+"
|
|
2754
2897
|
}
|
|
2755
|
-
|
|
2898
|
+
]
|
|
2756
2899
|
}
|
|
2757
2900
|
},
|
|
2758
|
-
"/session/:sessionId/
|
|
2901
|
+
"/session/:sessionId/goog/cast/start_tab_mirroring": {
|
|
2759
2902
|
POST: {
|
|
2760
|
-
command: "
|
|
2761
|
-
description: "
|
|
2762
|
-
ref: "https://
|
|
2903
|
+
command: "startCastTabMirroring",
|
|
2904
|
+
description: "Initiates tab mirroring for the current browser tab on the specified device.",
|
|
2905
|
+
ref: "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#741",
|
|
2763
2906
|
parameters: [
|
|
2764
2907
|
{
|
|
2765
|
-
name: "
|
|
2766
|
-
type: "
|
|
2767
|
-
description: "
|
|
2908
|
+
name: "sinkName",
|
|
2909
|
+
type: "string",
|
|
2910
|
+
description: "The name of the target device.",
|
|
2768
2911
|
required: true
|
|
2769
|
-
},
|
|
2770
|
-
{
|
|
2771
|
-
name: "metastate",
|
|
2772
|
-
type: "number",
|
|
2773
|
-
description: "metastate for the keypress",
|
|
2774
|
-
required: false
|
|
2775
|
-
},
|
|
2776
|
-
{
|
|
2777
|
-
name: "flags",
|
|
2778
|
-
type: "number",
|
|
2779
|
-
description: "flags for the keypress",
|
|
2780
|
-
required: false
|
|
2781
|
-
}
|
|
2782
|
-
],
|
|
2783
|
-
support: {
|
|
2784
|
-
android: {
|
|
2785
|
-
UiAutomator: "4.2+"
|
|
2786
2912
|
}
|
|
2913
|
+
]
|
|
2914
|
+
}
|
|
2915
|
+
},
|
|
2916
|
+
"/session/:sessionId/goog/cast/get_issue_message": {
|
|
2917
|
+
GET: {
|
|
2918
|
+
command: "getCastIssueMessage",
|
|
2919
|
+
description: "Returns error message if there is any issue in a Cast session.",
|
|
2920
|
+
ref: "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#751",
|
|
2921
|
+
parameters: [],
|
|
2922
|
+
returns: {
|
|
2923
|
+
type: "String",
|
|
2924
|
+
name: "message",
|
|
2925
|
+
description: "Error message, if any."
|
|
2787
2926
|
}
|
|
2788
2927
|
}
|
|
2789
2928
|
},
|
|
2790
|
-
"/session/:sessionId/
|
|
2929
|
+
"/session/:sessionId/goog/cast/stop_casting": {
|
|
2791
2930
|
POST: {
|
|
2792
|
-
command: "
|
|
2793
|
-
description: "
|
|
2794
|
-
ref: "https://
|
|
2931
|
+
command: "stopCasting",
|
|
2932
|
+
description: "Stops casting from media router to the specified device, if connected.",
|
|
2933
|
+
ref: "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#744",
|
|
2795
2934
|
parameters: [
|
|
2796
2935
|
{
|
|
2797
|
-
name: "
|
|
2936
|
+
name: "sinkName",
|
|
2798
2937
|
type: "string",
|
|
2799
|
-
description: "
|
|
2938
|
+
description: "The name of the target device.",
|
|
2800
2939
|
required: true
|
|
2801
|
-
},
|
|
2802
|
-
{
|
|
2803
|
-
name: "metastate",
|
|
2804
|
-
type: "string",
|
|
2805
|
-
description: "meta state to press the keycode with",
|
|
2806
|
-
required: false
|
|
2807
2940
|
}
|
|
2808
|
-
]
|
|
2809
|
-
support: {
|
|
2810
|
-
android: {
|
|
2811
|
-
UiAutomator: "4.2+"
|
|
2812
|
-
}
|
|
2813
|
-
}
|
|
2941
|
+
]
|
|
2814
2942
|
}
|
|
2815
2943
|
},
|
|
2816
|
-
"/
|
|
2944
|
+
"/shutdown": {
|
|
2817
2945
|
POST: {
|
|
2818
|
-
command: "
|
|
2819
|
-
description: "
|
|
2820
|
-
ref: "https://github.com/
|
|
2821
|
-
parameters: [
|
|
2822
|
-
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
name: "y",
|
|
2831
|
-
type: "number",
|
|
2832
|
-
description: "y offset to use for the center of the rotate gesture",
|
|
2833
|
-
required: true,
|
|
2834
|
-
default: 0
|
|
2835
|
-
},
|
|
2946
|
+
command: "shutdown",
|
|
2947
|
+
description: "Shutdown ChromeDriver process and consequently terminating all active sessions.",
|
|
2948
|
+
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L489-L498",
|
|
2949
|
+
parameters: []
|
|
2950
|
+
}
|
|
2951
|
+
},
|
|
2952
|
+
"/session/:sessionId/element/:elementId/screenshot": {
|
|
2953
|
+
GET: {
|
|
2954
|
+
command: "takeElementScreenshot",
|
|
2955
|
+
description: "The Take Element Screenshot command takes a screenshot of the visible region encompassed by the bounding rectangle of an element.",
|
|
2956
|
+
ref: "https://w3c.github.io/webdriver/#dfn-take-element-screenshot",
|
|
2957
|
+
variables: [
|
|
2836
2958
|
{
|
|
2837
|
-
name: "
|
|
2838
|
-
|
|
2839
|
-
description: "z offset to use for the center of the rotate gesture",
|
|
2840
|
-
required: true,
|
|
2841
|
-
default: 0
|
|
2959
|
+
name: "elementId",
|
|
2960
|
+
description: "the id of an element returned in a previous call to Find Element(s)"
|
|
2842
2961
|
}
|
|
2843
2962
|
],
|
|
2844
|
-
|
|
2845
|
-
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
|
|
2963
|
+
parameters: [
|
|
2964
|
+
{
|
|
2965
|
+
name: "scroll",
|
|
2966
|
+
type: "boolean",
|
|
2967
|
+
description: "scroll into view the element. Default: true",
|
|
2968
|
+
required: false
|
|
2850
2969
|
}
|
|
2851
|
-
|
|
2852
|
-
}
|
|
2853
|
-
},
|
|
2854
|
-
"/session/:sessionId/appium/device/current_activity": {
|
|
2855
|
-
GET: {
|
|
2856
|
-
command: "getCurrentActivity",
|
|
2857
|
-
description: "Get the name of the current Android activity.",
|
|
2858
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/",
|
|
2859
|
-
parameters: [],
|
|
2970
|
+
],
|
|
2860
2971
|
returns: {
|
|
2861
|
-
type: "
|
|
2862
|
-
name: "
|
|
2863
|
-
description: "
|
|
2864
|
-
},
|
|
2865
|
-
support: {
|
|
2866
|
-
android: {
|
|
2867
|
-
UiAutomator: "4.2+"
|
|
2868
|
-
}
|
|
2972
|
+
type: "String",
|
|
2973
|
+
name: "screenshot",
|
|
2974
|
+
description: "The base64-encoded PNG image data comprising the screenshot of the visible region of an element\u2019s bounding rectangle after it has been scrolled into view."
|
|
2869
2975
|
}
|
|
2870
2976
|
}
|
|
2871
2977
|
},
|
|
2872
|
-
"/session/:sessionId/
|
|
2978
|
+
"/session/:sessionId/se/log/types": {
|
|
2873
2979
|
GET: {
|
|
2874
|
-
command: "
|
|
2875
|
-
description: "Get
|
|
2876
|
-
ref: "https://
|
|
2980
|
+
command: "getLogTypes",
|
|
2981
|
+
description: "Get available log types.",
|
|
2982
|
+
ref: "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlogtypes",
|
|
2877
2983
|
parameters: [],
|
|
2878
2984
|
returns: {
|
|
2879
|
-
type: "
|
|
2880
|
-
name: "
|
|
2881
|
-
description: "
|
|
2882
|
-
},
|
|
2883
|
-
support: {
|
|
2884
|
-
android: {
|
|
2885
|
-
UiAutomator: "4.2+"
|
|
2886
|
-
}
|
|
2985
|
+
type: "String[]",
|
|
2986
|
+
name: "logTypes",
|
|
2987
|
+
description: "The list of available log types, example: browser, driver."
|
|
2887
2988
|
}
|
|
2888
2989
|
}
|
|
2889
2990
|
},
|
|
2890
|
-
"/session/:sessionId/
|
|
2991
|
+
"/session/:sessionId/se/log": {
|
|
2891
2992
|
POST: {
|
|
2892
|
-
command: "
|
|
2893
|
-
description: "
|
|
2894
|
-
ref: "https://
|
|
2993
|
+
command: "getLogs",
|
|
2994
|
+
description: "Get the log for a given log type. Log buffer is reset after each request.",
|
|
2995
|
+
ref: "https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlog",
|
|
2895
2996
|
parameters: [
|
|
2896
2997
|
{
|
|
2897
|
-
name: "
|
|
2998
|
+
name: "type",
|
|
2898
2999
|
type: "string",
|
|
2899
|
-
description: "
|
|
3000
|
+
description: "the log type",
|
|
2900
3001
|
required: true
|
|
2901
3002
|
}
|
|
2902
3003
|
],
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
|
|
3004
|
+
returns: {
|
|
3005
|
+
type: "Object[]",
|
|
3006
|
+
name: "logs",
|
|
3007
|
+
description: "The list of log entries."
|
|
3008
|
+
}
|
|
3009
|
+
}
|
|
3010
|
+
}
|
|
3011
|
+
};
|
|
3012
|
+
|
|
3013
|
+
// src/protocols/appium.ts
|
|
3014
|
+
var getLogTypes = "/session/:sessionId/se/log/types";
|
|
3015
|
+
var getLog = "/session/:sessionId/se/log";
|
|
3016
|
+
var chromiumLogCommands = {
|
|
3017
|
+
[getLogTypes]: chromium_default[getLogTypes],
|
|
3018
|
+
[getLog]: chromium_default[getLog]
|
|
3019
|
+
};
|
|
3020
|
+
var appium_default = {
|
|
3021
|
+
...chromiumLogCommands,
|
|
3022
|
+
"/session/:sessionId": {
|
|
3023
|
+
GET: {
|
|
3024
|
+
command: "getSession",
|
|
3025
|
+
description: "Retrieve the capabilities of the current session.",
|
|
3026
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
3027
|
+
deprecated: "Use `getAppiumSessionCapabilities` instead",
|
|
3028
|
+
parameters: [],
|
|
3029
|
+
returns: {
|
|
3030
|
+
type: "Object",
|
|
3031
|
+
name: "capabilities",
|
|
3032
|
+
description: "An object describing the session's capabilities."
|
|
2911
3033
|
}
|
|
2912
3034
|
}
|
|
2913
3035
|
},
|
|
2914
|
-
"/session/:sessionId/
|
|
3036
|
+
"/session/:sessionId/context": {
|
|
3037
|
+
GET: {
|
|
3038
|
+
command: "getAppiumContext",
|
|
3039
|
+
ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts",
|
|
3040
|
+
parameters: [],
|
|
3041
|
+
returns: {
|
|
3042
|
+
type: "Context",
|
|
3043
|
+
name: "context",
|
|
3044
|
+
description: "a string representing the current context or null representing 'no context'"
|
|
3045
|
+
}
|
|
3046
|
+
},
|
|
2915
3047
|
POST: {
|
|
2916
|
-
command: "
|
|
2917
|
-
|
|
2918
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/activate-app/",
|
|
3048
|
+
command: "switchAppiumContext",
|
|
3049
|
+
ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts",
|
|
2919
3050
|
parameters: [
|
|
2920
3051
|
{
|
|
2921
|
-
name: "
|
|
3052
|
+
name: "name",
|
|
2922
3053
|
type: "string",
|
|
2923
|
-
description: "
|
|
3054
|
+
description: "a string representing an available context",
|
|
2924
3055
|
required: true
|
|
2925
3056
|
}
|
|
2926
|
-
]
|
|
2927
|
-
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
3057
|
+
]
|
|
3058
|
+
}
|
|
3059
|
+
},
|
|
3060
|
+
"/session/:sessionId/contexts": {
|
|
3061
|
+
GET: {
|
|
3062
|
+
command: "getAppiumContexts",
|
|
3063
|
+
ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts",
|
|
3064
|
+
parameters: [],
|
|
3065
|
+
returns: {
|
|
3066
|
+
type: "Context[]",
|
|
3067
|
+
name: "contexts",
|
|
3068
|
+
description: "an array of strings representing available contexts, e.g. 'WEBVIEW', or 'NATIVE'"
|
|
2934
3069
|
}
|
|
2935
3070
|
}
|
|
2936
3071
|
},
|
|
2937
|
-
"/session/:sessionId/appium/
|
|
2938
|
-
|
|
2939
|
-
command: "
|
|
2940
|
-
description: "
|
|
2941
|
-
ref: "https://
|
|
2942
|
-
parameters: [
|
|
2943
|
-
|
|
2944
|
-
|
|
2945
|
-
|
|
2946
|
-
|
|
2947
|
-
required: true
|
|
2948
|
-
}
|
|
2949
|
-
],
|
|
2950
|
-
support: {
|
|
2951
|
-
ios: {
|
|
2952
|
-
XCUITest: "9.3+",
|
|
2953
|
-
UIAutomation: "8.0 to 9.3"
|
|
2954
|
-
},
|
|
2955
|
-
android: {
|
|
2956
|
-
UiAutomator: "4.2+"
|
|
2957
|
-
}
|
|
3072
|
+
"/session/:sessionId/appium/commands": {
|
|
3073
|
+
GET: {
|
|
3074
|
+
command: "getAppiumCommands",
|
|
3075
|
+
description: "Retrieve the endpoints and BiDi commands supported in the current session.",
|
|
3076
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/lib/protocol/routes.js",
|
|
3077
|
+
parameters: [],
|
|
3078
|
+
returns: {
|
|
3079
|
+
type: "Object",
|
|
3080
|
+
name: "commands",
|
|
3081
|
+
description: "Supported endpoints and BiDi commands, each grouped into common, driver-specific, and plugin-specific endpoints/commands."
|
|
2958
3082
|
}
|
|
2959
3083
|
}
|
|
2960
3084
|
},
|
|
2961
|
-
"/session/:sessionId/appium/
|
|
2962
|
-
|
|
2963
|
-
command: "
|
|
2964
|
-
description: "
|
|
2965
|
-
ref: "https://
|
|
2966
|
-
parameters: [
|
|
2967
|
-
|
|
2968
|
-
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
UiAutomator: "4.2+"
|
|
2985
|
-
}
|
|
3085
|
+
"/session/:sessionId/appium/extensions": {
|
|
3086
|
+
GET: {
|
|
3087
|
+
command: "getAppiumExtensions",
|
|
3088
|
+
description: "Retrieve the extension commands supported in the current session.",
|
|
3089
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/lib/protocol/routes.js",
|
|
3090
|
+
parameters: [],
|
|
3091
|
+
returns: {
|
|
3092
|
+
type: "Object",
|
|
3093
|
+
name: "commands",
|
|
3094
|
+
description: "Supported extension commands, grouped into driver-specific and plugin-specific commands."
|
|
3095
|
+
}
|
|
3096
|
+
}
|
|
3097
|
+
},
|
|
3098
|
+
"/session/:sessionId/appium/capabilities": {
|
|
3099
|
+
GET: {
|
|
3100
|
+
command: "getAppiumSessionCapabilities",
|
|
3101
|
+
description: "Retrieve the capabilities of the current session.",
|
|
3102
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/lib/protocol/routes.js",
|
|
3103
|
+
parameters: [],
|
|
3104
|
+
returns: {
|
|
3105
|
+
type: "Object",
|
|
3106
|
+
name: "capabilities",
|
|
3107
|
+
description: "An object describing the session's capabilities."
|
|
2986
3108
|
}
|
|
2987
3109
|
}
|
|
2988
3110
|
},
|
|
2989
|
-
"/session/:sessionId/appium/device/
|
|
3111
|
+
"/session/:sessionId/appium/device/shake": {
|
|
2990
3112
|
POST: {
|
|
2991
|
-
command: "
|
|
2992
|
-
description: "
|
|
2993
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
2994
|
-
parameters: [
|
|
2995
|
-
{
|
|
2996
|
-
name: "appId",
|
|
2997
|
-
type: "string",
|
|
2998
|
-
description: "App ID (package ID for Android, bundle ID for iOS)",
|
|
2999
|
-
required: true
|
|
3000
|
-
}
|
|
3001
|
-
],
|
|
3002
|
-
returns: {
|
|
3003
|
-
type: "boolean",
|
|
3004
|
-
name: "isAppInstalled",
|
|
3005
|
-
description: "Return true if installed, false if not"
|
|
3006
|
-
},
|
|
3113
|
+
command: "shake",
|
|
3114
|
+
description: "Perform a shake action on the device.",
|
|
3115
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/",
|
|
3116
|
+
parameters: [],
|
|
3007
3117
|
support: {
|
|
3008
3118
|
ios: {
|
|
3009
3119
|
XCUITest: "9.3+",
|
|
3010
3120
|
UIAutomation: "8.0 to 9.3"
|
|
3011
|
-
},
|
|
3012
|
-
android: {
|
|
3013
|
-
UiAutomator: "4.2+"
|
|
3014
3121
|
}
|
|
3015
3122
|
}
|
|
3016
3123
|
}
|
|
3017
3124
|
},
|
|
3018
|
-
"/session/:sessionId/appium/device/
|
|
3125
|
+
"/session/:sessionId/appium/device/lock": {
|
|
3019
3126
|
POST: {
|
|
3020
|
-
command: "
|
|
3021
|
-
description: "
|
|
3022
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3127
|
+
command: "lock",
|
|
3128
|
+
description: "Lock the device.",
|
|
3129
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/",
|
|
3023
3130
|
parameters: [
|
|
3024
3131
|
{
|
|
3025
|
-
name: "
|
|
3026
|
-
type: "
|
|
3027
|
-
description: "
|
|
3028
|
-
required:
|
|
3132
|
+
name: "seconds",
|
|
3133
|
+
type: "number",
|
|
3134
|
+
description: "how long to lock the screen (iOS only)",
|
|
3135
|
+
required: false
|
|
3029
3136
|
}
|
|
3030
3137
|
],
|
|
3031
|
-
returns: {
|
|
3032
|
-
type: "number",
|
|
3033
|
-
name: "appStatus",
|
|
3034
|
-
description: "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"
|
|
3035
|
-
},
|
|
3036
3138
|
support: {
|
|
3037
3139
|
ios: {
|
|
3038
|
-
|
|
3140
|
+
UIAutomation: "8.0 to 9.3"
|
|
3039
3141
|
},
|
|
3040
3142
|
android: {
|
|
3041
3143
|
UiAutomator: "4.2+"
|
|
3144
|
+
},
|
|
3145
|
+
windows: {
|
|
3146
|
+
Windows: "10+"
|
|
3042
3147
|
}
|
|
3043
3148
|
}
|
|
3044
3149
|
}
|
|
3045
3150
|
},
|
|
3046
|
-
"/session/:sessionId/appium/device/
|
|
3151
|
+
"/session/:sessionId/appium/device/unlock": {
|
|
3047
3152
|
POST: {
|
|
3048
|
-
command: "
|
|
3049
|
-
description: "
|
|
3050
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3051
|
-
parameters: [
|
|
3052
|
-
{
|
|
3053
|
-
name: "strategy",
|
|
3054
|
-
type: "string",
|
|
3055
|
-
description: "hide keyboard strategy (UIAutomation only), available strategies - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'",
|
|
3056
|
-
required: false
|
|
3057
|
-
},
|
|
3058
|
-
{
|
|
3059
|
-
name: "key",
|
|
3060
|
-
type: "string",
|
|
3061
|
-
description: "key value if strategy is 'pressKey'",
|
|
3062
|
-
required: false
|
|
3063
|
-
},
|
|
3064
|
-
{
|
|
3065
|
-
name: "keyCode",
|
|
3066
|
-
type: "string",
|
|
3067
|
-
description: "key code if strategy is 'pressKey'",
|
|
3068
|
-
required: false
|
|
3069
|
-
},
|
|
3070
|
-
{
|
|
3071
|
-
name: "keyName",
|
|
3072
|
-
type: "string",
|
|
3073
|
-
description: "key name if strategy is 'pressKey'",
|
|
3074
|
-
required: false
|
|
3075
|
-
}
|
|
3076
|
-
],
|
|
3153
|
+
command: "unlock",
|
|
3154
|
+
description: "Unlock the device.",
|
|
3155
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/",
|
|
3156
|
+
parameters: [],
|
|
3077
3157
|
support: {
|
|
3078
|
-
ios: {
|
|
3079
|
-
XCUITest: "9.3+",
|
|
3080
|
-
UIAutomation: "8.0 to 9.3"
|
|
3081
|
-
},
|
|
3082
3158
|
android: {
|
|
3083
3159
|
UiAutomator: "4.2+"
|
|
3084
3160
|
},
|
|
@@ -3088,22 +3164,18 @@ var appium_default = {
|
|
|
3088
3164
|
}
|
|
3089
3165
|
}
|
|
3090
3166
|
},
|
|
3091
|
-
"/session/:sessionId/appium/device/
|
|
3092
|
-
|
|
3093
|
-
command: "
|
|
3094
|
-
description: "
|
|
3095
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3167
|
+
"/session/:sessionId/appium/device/is_locked": {
|
|
3168
|
+
POST: {
|
|
3169
|
+
command: "isLocked",
|
|
3170
|
+
description: "Check whether the device is locked or not.",
|
|
3171
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/",
|
|
3096
3172
|
parameters: [],
|
|
3097
3173
|
returns: {
|
|
3098
3174
|
type: "boolean",
|
|
3099
|
-
name: "
|
|
3100
|
-
description: "True if the
|
|
3175
|
+
name: "isLocked",
|
|
3176
|
+
description: "True if the device is locked, false if not"
|
|
3101
3177
|
},
|
|
3102
3178
|
support: {
|
|
3103
|
-
ios: {
|
|
3104
|
-
XCUITest: "9.3+",
|
|
3105
|
-
UIAutomation: "8.0 to 9.3"
|
|
3106
|
-
},
|
|
3107
3179
|
android: {
|
|
3108
3180
|
UiAutomator: "4.2+"
|
|
3109
3181
|
},
|
|
@@ -3113,29 +3185,22 @@ var appium_default = {
|
|
|
3113
3185
|
}
|
|
3114
3186
|
}
|
|
3115
3187
|
},
|
|
3116
|
-
"/session/:sessionId/appium/
|
|
3188
|
+
"/session/:sessionId/appium/start_recording_screen": {
|
|
3117
3189
|
POST: {
|
|
3118
|
-
command: "
|
|
3119
|
-
description: "
|
|
3120
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3190
|
+
command: "startRecordingScreen",
|
|
3191
|
+
description: "Start recording the screen.",
|
|
3192
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/start-recording-screen/",
|
|
3121
3193
|
parameters: [
|
|
3122
3194
|
{
|
|
3123
|
-
name: "
|
|
3124
|
-
type: "
|
|
3125
|
-
description: "
|
|
3126
|
-
required:
|
|
3127
|
-
},
|
|
3128
|
-
{
|
|
3129
|
-
name: "data",
|
|
3130
|
-
type: "string",
|
|
3131
|
-
description: "contents of file in base64",
|
|
3132
|
-
required: true
|
|
3195
|
+
name: "options",
|
|
3196
|
+
type: "object",
|
|
3197
|
+
description: "command parameters that can contain keys like: remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport (see more description in Appium docs)",
|
|
3198
|
+
required: false
|
|
3133
3199
|
}
|
|
3134
3200
|
],
|
|
3135
3201
|
support: {
|
|
3136
3202
|
ios: {
|
|
3137
|
-
XCUITest: "9.3+"
|
|
3138
|
-
UIAutomation: "8.0 to 9.3"
|
|
3203
|
+
XCUITest: "9.3+"
|
|
3139
3204
|
},
|
|
3140
3205
|
android: {
|
|
3141
3206
|
UiAutomator: "4.2+"
|
|
@@ -3146,55 +3211,45 @@ var appium_default = {
|
|
|
3146
3211
|
}
|
|
3147
3212
|
}
|
|
3148
3213
|
},
|
|
3149
|
-
"/session/:sessionId/appium/
|
|
3214
|
+
"/session/:sessionId/appium/stop_recording_screen": {
|
|
3150
3215
|
POST: {
|
|
3151
|
-
command: "
|
|
3152
|
-
description: "
|
|
3153
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3216
|
+
command: "stopRecordingScreen",
|
|
3217
|
+
description: "Stop recording screen",
|
|
3218
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/stop-recording-screen/",
|
|
3154
3219
|
parameters: [
|
|
3155
3220
|
{
|
|
3156
|
-
name: "
|
|
3221
|
+
name: "remotePath",
|
|
3157
3222
|
type: "string",
|
|
3158
|
-
description: "path
|
|
3159
|
-
required:
|
|
3160
|
-
}
|
|
3161
|
-
],
|
|
3162
|
-
support: {
|
|
3163
|
-
ios: {
|
|
3164
|
-
XCUITest: "9.3+",
|
|
3165
|
-
UIAutomation: "8.0 to 9.3"
|
|
3223
|
+
description: "The path to the remote location, where the resulting video should be uploaded. The following protocols are supported http/https, ftp. This option only has an effect if there is screen recording process in progreess and forceRestart parameter is not set to true. Null or empty string value (the default setting) means the content of resulting file should be encoded as Base64.",
|
|
3224
|
+
required: false
|
|
3166
3225
|
},
|
|
3167
|
-
|
|
3168
|
-
|
|
3226
|
+
{
|
|
3227
|
+
name: "username",
|
|
3228
|
+
type: "string",
|
|
3229
|
+
description: "The name of the user for the remote authentication.",
|
|
3230
|
+
required: false
|
|
3169
3231
|
},
|
|
3170
|
-
windows: {
|
|
3171
|
-
Windows: "10+"
|
|
3172
|
-
}
|
|
3173
|
-
},
|
|
3174
|
-
returns: {
|
|
3175
|
-
type: "string",
|
|
3176
|
-
name: "response",
|
|
3177
|
-
description: "Contents of file in base64"
|
|
3178
|
-
}
|
|
3179
|
-
}
|
|
3180
|
-
},
|
|
3181
|
-
"/session/:sessionId/appium/device/pull_folder": {
|
|
3182
|
-
POST: {
|
|
3183
|
-
command: "pullFolder",
|
|
3184
|
-
description: "Retrieve a folder from the device's file system.",
|
|
3185
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/files/pull-folder/",
|
|
3186
|
-
parameters: [
|
|
3187
3232
|
{
|
|
3188
|
-
name: "
|
|
3233
|
+
name: "password",
|
|
3189
3234
|
type: "string",
|
|
3190
|
-
description: "
|
|
3191
|
-
required:
|
|
3235
|
+
description: "The password for the remote authentication.",
|
|
3236
|
+
required: false
|
|
3237
|
+
},
|
|
3238
|
+
{
|
|
3239
|
+
name: "method",
|
|
3240
|
+
type: "string",
|
|
3241
|
+
description: "The http multipart upload method name. The 'PUT' one is used by default.",
|
|
3242
|
+
required: false
|
|
3192
3243
|
}
|
|
3193
3244
|
],
|
|
3245
|
+
returns: {
|
|
3246
|
+
type: "string",
|
|
3247
|
+
name: "response",
|
|
3248
|
+
description: "Base64 encoded string. If remote_path is set, the response is empty string"
|
|
3249
|
+
},
|
|
3194
3250
|
support: {
|
|
3195
3251
|
ios: {
|
|
3196
|
-
XCUITest: "9.3+"
|
|
3197
|
-
UIAutomation: "8.0 to 9.3"
|
|
3252
|
+
XCUITest: "9.3+"
|
|
3198
3253
|
},
|
|
3199
3254
|
android: {
|
|
3200
3255
|
UiAutomator: "4.2+"
|
|
@@ -3205,51 +3260,17 @@ var appium_default = {
|
|
|
3205
3260
|
}
|
|
3206
3261
|
}
|
|
3207
3262
|
},
|
|
3208
|
-
"/session/:sessionId/appium/
|
|
3209
|
-
POST: {
|
|
3210
|
-
command: "toggleAirplaneMode",
|
|
3211
|
-
description: "Toggle airplane mode on device.",
|
|
3212
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/",
|
|
3213
|
-
parameters: [],
|
|
3214
|
-
support: {
|
|
3215
|
-
android: {
|
|
3216
|
-
UiAutomator: "4.2+"
|
|
3217
|
-
}
|
|
3218
|
-
}
|
|
3219
|
-
}
|
|
3220
|
-
},
|
|
3221
|
-
"/session/:sessionId/appium/device/toggle_data": {
|
|
3222
|
-
POST: {
|
|
3223
|
-
command: "toggleData",
|
|
3224
|
-
description: "Switch the state of data service.",
|
|
3225
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/",
|
|
3226
|
-
parameters: [],
|
|
3227
|
-
support: {
|
|
3228
|
-
android: {
|
|
3229
|
-
UiAutomator: "4.2+"
|
|
3230
|
-
}
|
|
3231
|
-
}
|
|
3232
|
-
}
|
|
3233
|
-
},
|
|
3234
|
-
"/session/:sessionId/appium/device/toggle_wifi": {
|
|
3235
|
-
POST: {
|
|
3236
|
-
command: "toggleWiFi",
|
|
3237
|
-
description: "Switch the state of the wifi service.",
|
|
3238
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/",
|
|
3239
|
-
parameters: [],
|
|
3240
|
-
support: {
|
|
3241
|
-
android: {
|
|
3242
|
-
UiAutomator: "4.2+"
|
|
3243
|
-
}
|
|
3244
|
-
}
|
|
3245
|
-
}
|
|
3246
|
-
},
|
|
3247
|
-
"/session/:sessionId/appium/device/toggle_location_services": {
|
|
3263
|
+
"/session/:sessionId/appium/performanceData/types": {
|
|
3248
3264
|
POST: {
|
|
3249
|
-
command: "
|
|
3250
|
-
description: "
|
|
3251
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3265
|
+
command: "getPerformanceDataTypes",
|
|
3266
|
+
description: "Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery.",
|
|
3267
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/",
|
|
3252
3268
|
parameters: [],
|
|
3269
|
+
returns: {
|
|
3270
|
+
type: "string[]",
|
|
3271
|
+
name: "performanceTypes",
|
|
3272
|
+
description: "The available performance data types (cpuinfo|batteryinfo|networkinfo|memoryinfo)"
|
|
3273
|
+
},
|
|
3253
3274
|
support: {
|
|
3254
3275
|
android: {
|
|
3255
3276
|
UiAutomator: "4.2+"
|
|
@@ -3257,19 +3278,36 @@ var appium_default = {
|
|
|
3257
3278
|
}
|
|
3258
3279
|
}
|
|
3259
3280
|
},
|
|
3260
|
-
"/session/:sessionId/appium/
|
|
3281
|
+
"/session/:sessionId/appium/getPerformanceData": {
|
|
3261
3282
|
POST: {
|
|
3262
|
-
command: "
|
|
3263
|
-
description: "
|
|
3264
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3283
|
+
command: "getPerformanceData",
|
|
3284
|
+
description: "Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery.",
|
|
3285
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/",
|
|
3265
3286
|
parameters: [
|
|
3266
3287
|
{
|
|
3267
|
-
name: "
|
|
3288
|
+
name: "packageName",
|
|
3268
3289
|
type: "string",
|
|
3269
|
-
description: "
|
|
3290
|
+
description: "the package name of the application",
|
|
3291
|
+
required: true
|
|
3292
|
+
},
|
|
3293
|
+
{
|
|
3294
|
+
name: "dataType",
|
|
3295
|
+
type: "string",
|
|
3296
|
+
description: "the type of system state which wants to read. It should be one of the supported performance data types",
|
|
3270
3297
|
required: true
|
|
3298
|
+
},
|
|
3299
|
+
{
|
|
3300
|
+
name: "dataReadTimeout",
|
|
3301
|
+
type: "number",
|
|
3302
|
+
description: "the number of attempts to read",
|
|
3303
|
+
required: false
|
|
3271
3304
|
}
|
|
3272
3305
|
],
|
|
3306
|
+
returns: {
|
|
3307
|
+
type: "string[]",
|
|
3308
|
+
name: "performanceData",
|
|
3309
|
+
description: "The information type of the system state which is supported to read as like cpu, memory, network traffic, and battery"
|
|
3310
|
+
},
|
|
3273
3311
|
support: {
|
|
3274
3312
|
android: {
|
|
3275
3313
|
UiAutomator: "4.2+"
|
|
@@ -3277,12 +3315,31 @@ var appium_default = {
|
|
|
3277
3315
|
}
|
|
3278
3316
|
}
|
|
3279
3317
|
},
|
|
3280
|
-
"/session/:sessionId/appium/device/
|
|
3318
|
+
"/session/:sessionId/appium/device/press_keycode": {
|
|
3281
3319
|
POST: {
|
|
3282
|
-
command: "
|
|
3283
|
-
description: "
|
|
3284
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3285
|
-
parameters: [
|
|
3320
|
+
command: "pressKeyCode",
|
|
3321
|
+
description: "Press a particular key on the device.",
|
|
3322
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/",
|
|
3323
|
+
parameters: [
|
|
3324
|
+
{
|
|
3325
|
+
name: "keycode",
|
|
3326
|
+
type: "number",
|
|
3327
|
+
description: "keycode to press",
|
|
3328
|
+
required: true
|
|
3329
|
+
},
|
|
3330
|
+
{
|
|
3331
|
+
name: "metastate",
|
|
3332
|
+
type: "number",
|
|
3333
|
+
description: "meta state to press the keycode with",
|
|
3334
|
+
required: false
|
|
3335
|
+
},
|
|
3336
|
+
{
|
|
3337
|
+
name: "flags",
|
|
3338
|
+
type: "number",
|
|
3339
|
+
description: "flags for the keypress",
|
|
3340
|
+
required: false
|
|
3341
|
+
}
|
|
3342
|
+
],
|
|
3286
3343
|
support: {
|
|
3287
3344
|
android: {
|
|
3288
3345
|
UiAutomator: "4.2+"
|
|
@@ -3290,67 +3347,54 @@ var appium_default = {
|
|
|
3290
3347
|
}
|
|
3291
3348
|
}
|
|
3292
3349
|
},
|
|
3293
|
-
"/session/:sessionId/appium/device/
|
|
3350
|
+
"/session/:sessionId/appium/device/long_press_keycode": {
|
|
3294
3351
|
POST: {
|
|
3295
|
-
command: "
|
|
3296
|
-
description: "
|
|
3297
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3352
|
+
command: "longPressKeyCode",
|
|
3353
|
+
description: "Press and hold a particular key code on the device.",
|
|
3354
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/",
|
|
3298
3355
|
parameters: [
|
|
3299
3356
|
{
|
|
3300
|
-
name: "
|
|
3301
|
-
type: "
|
|
3302
|
-
description: "
|
|
3303
|
-
required: true
|
|
3304
|
-
},
|
|
3305
|
-
{
|
|
3306
|
-
name: "appActivity",
|
|
3307
|
-
type: "string",
|
|
3308
|
-
description: "name of activity",
|
|
3357
|
+
name: "keycode",
|
|
3358
|
+
type: "number",
|
|
3359
|
+
description: "keycode to press on the device",
|
|
3309
3360
|
required: true
|
|
3310
3361
|
},
|
|
3311
3362
|
{
|
|
3312
|
-
name: "
|
|
3313
|
-
type: "
|
|
3314
|
-
description: "
|
|
3363
|
+
name: "metastate",
|
|
3364
|
+
type: "number",
|
|
3365
|
+
description: "metastate for the keypress",
|
|
3315
3366
|
required: false
|
|
3316
3367
|
},
|
|
3317
3368
|
{
|
|
3318
|
-
name: "
|
|
3319
|
-
type: "
|
|
3320
|
-
description: "
|
|
3369
|
+
name: "flags",
|
|
3370
|
+
type: "number",
|
|
3371
|
+
description: "flags for the keypress",
|
|
3321
3372
|
required: false
|
|
3322
|
-
}
|
|
3323
|
-
|
|
3324
|
-
|
|
3325
|
-
|
|
3326
|
-
|
|
3327
|
-
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
|
-
|
|
3332
|
-
|
|
3333
|
-
|
|
3334
|
-
|
|
3335
|
-
|
|
3336
|
-
|
|
3337
|
-
{
|
|
3338
|
-
name: "intentFlags",
|
|
3339
|
-
type: "string",
|
|
3340
|
-
description: "flags that will be used to start activity",
|
|
3341
|
-
required: false,
|
|
3342
|
-
default: "0x10200000"
|
|
3343
|
-
},
|
|
3373
|
+
}
|
|
3374
|
+
],
|
|
3375
|
+
support: {
|
|
3376
|
+
android: {
|
|
3377
|
+
UiAutomator: "4.2+"
|
|
3378
|
+
}
|
|
3379
|
+
}
|
|
3380
|
+
}
|
|
3381
|
+
},
|
|
3382
|
+
"/session/:sessionId/appium/device/keyevent": {
|
|
3383
|
+
POST: {
|
|
3384
|
+
command: "sendKeyEvent",
|
|
3385
|
+
description: "Send a key code to the device.",
|
|
3386
|
+
ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
|
|
3387
|
+
parameters: [
|
|
3344
3388
|
{
|
|
3345
|
-
name: "
|
|
3389
|
+
name: "keycode",
|
|
3346
3390
|
type: "string",
|
|
3347
|
-
description: "
|
|
3348
|
-
required:
|
|
3391
|
+
description: "keycode to press",
|
|
3392
|
+
required: true
|
|
3349
3393
|
},
|
|
3350
3394
|
{
|
|
3351
|
-
name: "
|
|
3395
|
+
name: "metastate",
|
|
3352
3396
|
type: "string",
|
|
3353
|
-
description: "
|
|
3397
|
+
description: "meta state to press the keycode with",
|
|
3354
3398
|
required: false
|
|
3355
3399
|
}
|
|
3356
3400
|
],
|
|
@@ -3361,55 +3405,72 @@ var appium_default = {
|
|
|
3361
3405
|
}
|
|
3362
3406
|
}
|
|
3363
3407
|
},
|
|
3364
|
-
"/session/:sessionId/
|
|
3365
|
-
|
|
3366
|
-
command: "
|
|
3367
|
-
description: "
|
|
3368
|
-
ref: "https://
|
|
3369
|
-
parameters: [
|
|
3370
|
-
|
|
3371
|
-
|
|
3372
|
-
|
|
3373
|
-
|
|
3374
|
-
|
|
3408
|
+
"/session/:sessionId/rotation": {
|
|
3409
|
+
POST: {
|
|
3410
|
+
command: "rotateDevice",
|
|
3411
|
+
description: "Rotate the device in three dimensions.",
|
|
3412
|
+
ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation",
|
|
3413
|
+
parameters: [
|
|
3414
|
+
{
|
|
3415
|
+
name: "x",
|
|
3416
|
+
type: "number",
|
|
3417
|
+
description: "x offset to use for the center of the rotate gesture",
|
|
3418
|
+
required: true,
|
|
3419
|
+
default: 0
|
|
3420
|
+
},
|
|
3421
|
+
{
|
|
3422
|
+
name: "y",
|
|
3423
|
+
type: "number",
|
|
3424
|
+
description: "y offset to use for the center of the rotate gesture",
|
|
3425
|
+
required: true,
|
|
3426
|
+
default: 0
|
|
3427
|
+
},
|
|
3428
|
+
{
|
|
3429
|
+
name: "z",
|
|
3430
|
+
type: "number",
|
|
3431
|
+
description: "z offset to use for the center of the rotate gesture",
|
|
3432
|
+
required: true,
|
|
3433
|
+
default: 0
|
|
3434
|
+
}
|
|
3435
|
+
],
|
|
3375
3436
|
support: {
|
|
3437
|
+
ios: {
|
|
3438
|
+
UIAutomation: "8.0 to 9.3"
|
|
3439
|
+
},
|
|
3376
3440
|
android: {
|
|
3377
3441
|
UiAutomator: "4.2+"
|
|
3378
3442
|
}
|
|
3379
3443
|
}
|
|
3380
3444
|
}
|
|
3381
3445
|
},
|
|
3382
|
-
"/session/:sessionId/appium/device/
|
|
3446
|
+
"/session/:sessionId/appium/device/current_activity": {
|
|
3383
3447
|
GET: {
|
|
3384
|
-
command: "
|
|
3385
|
-
description: "Get the
|
|
3386
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3448
|
+
command: "getCurrentActivity",
|
|
3449
|
+
description: "Get the name of the current Android activity.",
|
|
3450
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/",
|
|
3387
3451
|
parameters: [],
|
|
3388
3452
|
returns: {
|
|
3389
3453
|
type: "string",
|
|
3390
|
-
name: "
|
|
3391
|
-
description: "
|
|
3454
|
+
name: "activity",
|
|
3455
|
+
description: "Name of the current activity"
|
|
3392
3456
|
},
|
|
3393
3457
|
support: {
|
|
3394
|
-
ios: {
|
|
3395
|
-
XCUITest: "9.3+",
|
|
3396
|
-
UIAutomation: "8.0 to 9.3"
|
|
3397
|
-
},
|
|
3398
3458
|
android: {
|
|
3399
3459
|
UiAutomator: "4.2+"
|
|
3400
3460
|
}
|
|
3401
3461
|
}
|
|
3402
3462
|
}
|
|
3403
3463
|
},
|
|
3404
|
-
"/session/:sessionId/appium/device/
|
|
3464
|
+
"/session/:sessionId/appium/device/current_package": {
|
|
3405
3465
|
GET: {
|
|
3406
|
-
command: "
|
|
3407
|
-
description: "Get
|
|
3408
|
-
ref: "https://github.
|
|
3466
|
+
command: "getCurrentPackage",
|
|
3467
|
+
description: "Get the name of the current Android package.",
|
|
3468
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/",
|
|
3409
3469
|
parameters: [],
|
|
3410
3470
|
returns: {
|
|
3411
|
-
type: "
|
|
3412
|
-
name: "
|
|
3471
|
+
type: "string",
|
|
3472
|
+
name: "package",
|
|
3473
|
+
description: "Name of the current package"
|
|
3413
3474
|
},
|
|
3414
3475
|
support: {
|
|
3415
3476
|
android: {
|
|
@@ -3418,54 +3479,19 @@ var appium_default = {
|
|
|
3418
3479
|
}
|
|
3419
3480
|
}
|
|
3420
3481
|
},
|
|
3421
|
-
"/session/:sessionId/appium/
|
|
3482
|
+
"/session/:sessionId/appium/device/install_app": {
|
|
3422
3483
|
POST: {
|
|
3423
|
-
command: "
|
|
3424
|
-
description: "
|
|
3425
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3484
|
+
command: "installApp",
|
|
3485
|
+
description: "Install the given app onto the device.",
|
|
3486
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/install-app/",
|
|
3426
3487
|
parameters: [
|
|
3427
3488
|
{
|
|
3428
|
-
name: "
|
|
3429
|
-
type: "
|
|
3430
|
-
description: "
|
|
3489
|
+
name: "appPath",
|
|
3490
|
+
type: "string",
|
|
3491
|
+
description: "path to application .apk file",
|
|
3431
3492
|
required: true
|
|
3432
3493
|
}
|
|
3433
3494
|
],
|
|
3434
|
-
support: {
|
|
3435
|
-
ios: {
|
|
3436
|
-
XCUITest: "9.3+"
|
|
3437
|
-
}
|
|
3438
|
-
}
|
|
3439
|
-
}
|
|
3440
|
-
},
|
|
3441
|
-
"/session/:sessionId/appium/simulator/toggle_touch_id_enrollment": {
|
|
3442
|
-
POST: {
|
|
3443
|
-
command: "toggleEnrollTouchId",
|
|
3444
|
-
description: "Toggle the simulator being [enrolled](https://support.apple.com/en-ca/ht201371) to accept touchId (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true. When `allowTouchIdEnroll` is set to true the Simulator will be enrolled by default, and the 'Toggle Touch ID Enrollment' changes the enrollment state. This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.",
|
|
3445
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/",
|
|
3446
|
-
parameters: [
|
|
3447
|
-
{
|
|
3448
|
-
name: "enabled",
|
|
3449
|
-
type: "boolean",
|
|
3450
|
-
description: "equals to true if TouchID enrollment should be enabled",
|
|
3451
|
-
required: false,
|
|
3452
|
-
default: true
|
|
3453
|
-
}
|
|
3454
|
-
],
|
|
3455
|
-
support: {
|
|
3456
|
-
ios: {
|
|
3457
|
-
XCUITest: "9.3+"
|
|
3458
|
-
}
|
|
3459
|
-
}
|
|
3460
|
-
}
|
|
3461
|
-
},
|
|
3462
|
-
"/session/:sessionId/appium/app/launch": {
|
|
3463
|
-
POST: {
|
|
3464
|
-
command: "launchApp",
|
|
3465
|
-
description: "Launch an app on device.",
|
|
3466
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/",
|
|
3467
|
-
deprecated: "For iOS, utilize `driver.execute('mobile: launchApp', { ... })`, and for Android, make use of `driver.execute('mobile: activateApp', { ... })`.",
|
|
3468
|
-
parameters: [],
|
|
3469
3495
|
support: {
|
|
3470
3496
|
ios: {
|
|
3471
3497
|
XCUITest: "9.3+",
|
|
@@ -3477,17 +3503,22 @@ var appium_default = {
|
|
|
3477
3503
|
}
|
|
3478
3504
|
}
|
|
3479
3505
|
},
|
|
3480
|
-
"/session/:sessionId/appium/
|
|
3506
|
+
"/session/:sessionId/appium/device/activate_app": {
|
|
3481
3507
|
POST: {
|
|
3482
|
-
command: "
|
|
3483
|
-
description: "
|
|
3484
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/
|
|
3485
|
-
|
|
3486
|
-
|
|
3508
|
+
command: "activateApp",
|
|
3509
|
+
description: "Activate the given app onto the device",
|
|
3510
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/activate-app/",
|
|
3511
|
+
parameters: [
|
|
3512
|
+
{
|
|
3513
|
+
name: "appId",
|
|
3514
|
+
type: "string",
|
|
3515
|
+
description: "App ID (package ID for Android, bundle ID for iOS)",
|
|
3516
|
+
required: true
|
|
3517
|
+
}
|
|
3518
|
+
],
|
|
3487
3519
|
support: {
|
|
3488
3520
|
ios: {
|
|
3489
|
-
XCUITest: "9.3+"
|
|
3490
|
-
UIAutomation: "8.0 to 9.3"
|
|
3521
|
+
XCUITest: "9.3+"
|
|
3491
3522
|
},
|
|
3492
3523
|
android: {
|
|
3493
3524
|
UiAutomator: "4.2+"
|
|
@@ -3495,19 +3526,17 @@ var appium_default = {
|
|
|
3495
3526
|
}
|
|
3496
3527
|
}
|
|
3497
3528
|
},
|
|
3498
|
-
"/session/:sessionId/appium/
|
|
3529
|
+
"/session/:sessionId/appium/device/remove_app": {
|
|
3499
3530
|
POST: {
|
|
3500
|
-
command: "
|
|
3501
|
-
description: "
|
|
3502
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/
|
|
3503
|
-
deprecated: "Use `driver.execute('mobile: backgroundApp', { ... })` instead",
|
|
3531
|
+
command: "removeApp",
|
|
3532
|
+
description: "Remove an app from the device.",
|
|
3533
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/remove-app/",
|
|
3504
3534
|
parameters: [
|
|
3505
3535
|
{
|
|
3506
|
-
name: "
|
|
3507
|
-
type: "
|
|
3508
|
-
description: "
|
|
3509
|
-
required: true
|
|
3510
|
-
default: "null"
|
|
3536
|
+
name: "appId",
|
|
3537
|
+
type: "string",
|
|
3538
|
+
description: "App ID (package ID for Android, bundle ID for iOS)",
|
|
3539
|
+
required: true
|
|
3511
3540
|
}
|
|
3512
3541
|
],
|
|
3513
3542
|
support: {
|
|
@@ -3521,55 +3550,51 @@ var appium_default = {
|
|
|
3521
3550
|
}
|
|
3522
3551
|
}
|
|
3523
3552
|
},
|
|
3524
|
-
"/session/:sessionId/appium/
|
|
3553
|
+
"/session/:sessionId/appium/device/terminate_app": {
|
|
3525
3554
|
POST: {
|
|
3526
|
-
command: "
|
|
3527
|
-
description: "
|
|
3528
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/
|
|
3555
|
+
command: "terminateApp",
|
|
3556
|
+
description: "Terminate the given app on the device",
|
|
3557
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/terminate-app/",
|
|
3529
3558
|
parameters: [
|
|
3530
3559
|
{
|
|
3531
|
-
name: "
|
|
3560
|
+
name: "appId",
|
|
3532
3561
|
type: "string",
|
|
3533
|
-
description: "
|
|
3562
|
+
description: "App ID (package ID for Android, bundle ID for iOS)",
|
|
3534
3563
|
required: true
|
|
3535
3564
|
},
|
|
3536
3565
|
{
|
|
3537
|
-
name: "
|
|
3538
|
-
type: "
|
|
3539
|
-
description: "
|
|
3540
|
-
required: true
|
|
3566
|
+
name: "options",
|
|
3567
|
+
type: "object",
|
|
3568
|
+
description: 'Command options. E.g. "timeout": (Only Android) Timeout to retry terminate the app (see more in Appium docs)'
|
|
3541
3569
|
}
|
|
3542
3570
|
],
|
|
3543
3571
|
support: {
|
|
3572
|
+
ios: {
|
|
3573
|
+
XCUITest: "9.3+"
|
|
3574
|
+
},
|
|
3544
3575
|
android: {
|
|
3545
3576
|
UiAutomator: "4.2+"
|
|
3546
3577
|
}
|
|
3547
3578
|
}
|
|
3548
3579
|
}
|
|
3549
3580
|
},
|
|
3550
|
-
"/session/:sessionId/appium/
|
|
3581
|
+
"/session/:sessionId/appium/device/app_installed": {
|
|
3551
3582
|
POST: {
|
|
3552
|
-
command: "
|
|
3553
|
-
description: "
|
|
3554
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/
|
|
3583
|
+
command: "isAppInstalled",
|
|
3584
|
+
description: "Check whether the specified app is installed on the device.",
|
|
3585
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/is-app-installed/",
|
|
3555
3586
|
parameters: [
|
|
3556
3587
|
{
|
|
3557
|
-
name: "
|
|
3558
|
-
type: "string",
|
|
3559
|
-
description: "language code",
|
|
3560
|
-
required: false
|
|
3561
|
-
},
|
|
3562
|
-
{
|
|
3563
|
-
name: "stringFile",
|
|
3588
|
+
name: "appId",
|
|
3564
3589
|
type: "string",
|
|
3565
|
-
description: "
|
|
3566
|
-
required:
|
|
3590
|
+
description: "App ID (package ID for Android, bundle ID for iOS)",
|
|
3591
|
+
required: true
|
|
3567
3592
|
}
|
|
3568
3593
|
],
|
|
3569
3594
|
returns: {
|
|
3570
|
-
type: "
|
|
3571
|
-
name: "
|
|
3572
|
-
description: "
|
|
3595
|
+
type: "boolean",
|
|
3596
|
+
name: "isAppInstalled",
|
|
3597
|
+
description: "Return true if installed, false if not"
|
|
3573
3598
|
},
|
|
3574
3599
|
support: {
|
|
3575
3600
|
ios: {
|
|
@@ -3582,24 +3607,24 @@ var appium_default = {
|
|
|
3582
3607
|
}
|
|
3583
3608
|
}
|
|
3584
3609
|
},
|
|
3585
|
-
"/session/:sessionId/appium/
|
|
3610
|
+
"/session/:sessionId/appium/device/app_state": {
|
|
3586
3611
|
POST: {
|
|
3587
|
-
command: "
|
|
3588
|
-
|
|
3589
|
-
|
|
3590
|
-
{
|
|
3591
|
-
name: "elementId",
|
|
3592
|
-
description: "the id of an element returned in a previous call to Find Element(s)"
|
|
3593
|
-
}
|
|
3594
|
-
],
|
|
3612
|
+
command: "queryAppState",
|
|
3613
|
+
description: "Get the given app status on the device",
|
|
3614
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/app-state/",
|
|
3595
3615
|
parameters: [
|
|
3596
3616
|
{
|
|
3597
|
-
name: "
|
|
3617
|
+
name: "appId",
|
|
3598
3618
|
type: "string",
|
|
3599
|
-
description: "
|
|
3619
|
+
description: "App ID (package ID for Android, bundle ID for iOS)",
|
|
3600
3620
|
required: true
|
|
3601
3621
|
}
|
|
3602
3622
|
],
|
|
3623
|
+
returns: {
|
|
3624
|
+
type: "number",
|
|
3625
|
+
name: "appStatus",
|
|
3626
|
+
description: "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"
|
|
3627
|
+
},
|
|
3603
3628
|
support: {
|
|
3604
3629
|
ios: {
|
|
3605
3630
|
XCUITest: "9.3+"
|
|
@@ -3610,23 +3635,35 @@ var appium_default = {
|
|
|
3610
3635
|
}
|
|
3611
3636
|
}
|
|
3612
3637
|
},
|
|
3613
|
-
"/session/:sessionId/appium/
|
|
3638
|
+
"/session/:sessionId/appium/device/hide_keyboard": {
|
|
3614
3639
|
POST: {
|
|
3615
|
-
command: "
|
|
3616
|
-
description: "
|
|
3617
|
-
ref: "https://github.
|
|
3618
|
-
variables: [
|
|
3619
|
-
{
|
|
3620
|
-
name: "elementId",
|
|
3621
|
-
description: "the id of an element returned in a previous call to Find Element(s)"
|
|
3622
|
-
}
|
|
3623
|
-
],
|
|
3640
|
+
command: "hideKeyboard",
|
|
3641
|
+
description: "Hide soft keyboard.",
|
|
3642
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/keys/hide-keyboard/",
|
|
3624
3643
|
parameters: [
|
|
3625
3644
|
{
|
|
3626
|
-
name: "
|
|
3645
|
+
name: "strategy",
|
|
3627
3646
|
type: "string",
|
|
3628
|
-
description: "
|
|
3629
|
-
required:
|
|
3647
|
+
description: "hide keyboard strategy (UIAutomation only), available strategies - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'",
|
|
3648
|
+
required: false
|
|
3649
|
+
},
|
|
3650
|
+
{
|
|
3651
|
+
name: "key",
|
|
3652
|
+
type: "string",
|
|
3653
|
+
description: "key value if strategy is 'pressKey'",
|
|
3654
|
+
required: false
|
|
3655
|
+
},
|
|
3656
|
+
{
|
|
3657
|
+
name: "keyCode",
|
|
3658
|
+
type: "string",
|
|
3659
|
+
description: "key code if strategy is 'pressKey'",
|
|
3660
|
+
required: false
|
|
3661
|
+
},
|
|
3662
|
+
{
|
|
3663
|
+
name: "keyName",
|
|
3664
|
+
type: "string",
|
|
3665
|
+
description: "key name if strategy is 'pressKey'",
|
|
3666
|
+
required: false
|
|
3630
3667
|
}
|
|
3631
3668
|
],
|
|
3632
3669
|
support: {
|
|
@@ -3636,20 +3673,23 @@ var appium_default = {
|
|
|
3636
3673
|
},
|
|
3637
3674
|
android: {
|
|
3638
3675
|
UiAutomator: "4.2+"
|
|
3676
|
+
},
|
|
3677
|
+
windows: {
|
|
3678
|
+
Windows: "10+"
|
|
3639
3679
|
}
|
|
3640
3680
|
}
|
|
3641
3681
|
}
|
|
3642
3682
|
},
|
|
3643
|
-
"/session/:sessionId/appium/
|
|
3683
|
+
"/session/:sessionId/appium/device/is_keyboard_shown": {
|
|
3644
3684
|
GET: {
|
|
3645
|
-
command: "
|
|
3646
|
-
description: "
|
|
3647
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/
|
|
3685
|
+
command: "isKeyboardShown",
|
|
3686
|
+
description: "Whether or not the soft keyboard is shown.",
|
|
3687
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/keys/is-keyboard-shown/",
|
|
3648
3688
|
parameters: [],
|
|
3649
3689
|
returns: {
|
|
3650
|
-
type: "
|
|
3651
|
-
name: "
|
|
3652
|
-
description: "
|
|
3690
|
+
type: "boolean",
|
|
3691
|
+
name: "isKeyboardShown",
|
|
3692
|
+
description: "True if the keyboard is shown"
|
|
3653
3693
|
},
|
|
3654
3694
|
support: {
|
|
3655
3695
|
ios: {
|
|
@@ -3663,16 +3703,24 @@ var appium_default = {
|
|
|
3663
3703
|
Windows: "10+"
|
|
3664
3704
|
}
|
|
3665
3705
|
}
|
|
3666
|
-
}
|
|
3706
|
+
}
|
|
3707
|
+
},
|
|
3708
|
+
"/session/:sessionId/appium/device/push_file": {
|
|
3667
3709
|
POST: {
|
|
3668
|
-
command: "
|
|
3669
|
-
description: "
|
|
3670
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/
|
|
3710
|
+
command: "pushFile",
|
|
3711
|
+
description: "Place a file onto the device in a particular place.",
|
|
3712
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/files/push-file/",
|
|
3671
3713
|
parameters: [
|
|
3672
3714
|
{
|
|
3673
|
-
name: "
|
|
3674
|
-
type: "
|
|
3675
|
-
description: "
|
|
3715
|
+
name: "path",
|
|
3716
|
+
type: "string",
|
|
3717
|
+
description: "path to install the data to",
|
|
3718
|
+
required: true
|
|
3719
|
+
},
|
|
3720
|
+
{
|
|
3721
|
+
name: "data",
|
|
3722
|
+
type: "string",
|
|
3723
|
+
description: "contents of file in base64",
|
|
3676
3724
|
required: true
|
|
3677
3725
|
}
|
|
3678
3726
|
],
|
|
@@ -3690,16 +3738,16 @@ var appium_default = {
|
|
|
3690
3738
|
}
|
|
3691
3739
|
}
|
|
3692
3740
|
},
|
|
3693
|
-
"/session/:sessionId/appium/
|
|
3741
|
+
"/session/:sessionId/appium/device/pull_file": {
|
|
3694
3742
|
POST: {
|
|
3695
|
-
command: "
|
|
3696
|
-
description: "
|
|
3697
|
-
ref: "https://github.
|
|
3743
|
+
command: "pullFile",
|
|
3744
|
+
description: "Retrieve a file from the device's file system.",
|
|
3745
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/files/pull-file/",
|
|
3698
3746
|
parameters: [
|
|
3699
3747
|
{
|
|
3700
|
-
name: "
|
|
3701
|
-
type: "
|
|
3702
|
-
description: "
|
|
3748
|
+
name: "path",
|
|
3749
|
+
type: "string",
|
|
3750
|
+
description: "path on the device to pull file from",
|
|
3703
3751
|
required: true
|
|
3704
3752
|
}
|
|
3705
3753
|
],
|
|
@@ -3707,55 +3755,54 @@ var appium_default = {
|
|
|
3707
3755
|
ios: {
|
|
3708
3756
|
XCUITest: "9.3+",
|
|
3709
3757
|
UIAutomation: "8.0 to 9.3"
|
|
3758
|
+
},
|
|
3759
|
+
android: {
|
|
3760
|
+
UiAutomator: "4.2+"
|
|
3761
|
+
},
|
|
3762
|
+
windows: {
|
|
3763
|
+
Windows: "10+"
|
|
3710
3764
|
}
|
|
3765
|
+
},
|
|
3766
|
+
returns: {
|
|
3767
|
+
type: "string",
|
|
3768
|
+
name: "response",
|
|
3769
|
+
description: "Contents of file in base64"
|
|
3711
3770
|
}
|
|
3712
3771
|
}
|
|
3713
3772
|
},
|
|
3714
|
-
"/session/:sessionId/appium/device/
|
|
3773
|
+
"/session/:sessionId/appium/device/pull_folder": {
|
|
3715
3774
|
POST: {
|
|
3716
|
-
command: "
|
|
3717
|
-
description: "
|
|
3718
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3775
|
+
command: "pullFolder",
|
|
3776
|
+
description: "Retrieve a folder from the device's file system.",
|
|
3777
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/files/pull-folder/",
|
|
3719
3778
|
parameters: [
|
|
3720
3779
|
{
|
|
3721
|
-
name: "
|
|
3722
|
-
type: "string",
|
|
3723
|
-
description: "the phone number to call to",
|
|
3724
|
-
required: true
|
|
3725
|
-
},
|
|
3726
|
-
{
|
|
3727
|
-
name: "action",
|
|
3780
|
+
name: "path",
|
|
3728
3781
|
type: "string",
|
|
3729
|
-
description: "
|
|
3782
|
+
description: "path to an entire folder on the device",
|
|
3730
3783
|
required: true
|
|
3731
3784
|
}
|
|
3732
3785
|
],
|
|
3733
3786
|
support: {
|
|
3787
|
+
ios: {
|
|
3788
|
+
XCUITest: "9.3+",
|
|
3789
|
+
UIAutomation: "8.0 to 9.3"
|
|
3790
|
+
},
|
|
3734
3791
|
android: {
|
|
3735
3792
|
UiAutomator: "4.2+"
|
|
3736
|
-
}
|
|
3737
|
-
}
|
|
3738
|
-
}
|
|
3739
|
-
},
|
|
3740
|
-
"/session/:sessionId/appium/device/gsm_signal": {
|
|
3741
|
-
POST: {
|
|
3742
|
-
command: "gsmSignal",
|
|
3743
|
-
description: "Set GSM signal strength (Emulator only).",
|
|
3744
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/",
|
|
3745
|
-
parameters: [
|
|
3746
|
-
{
|
|
3747
|
-
name: "signalStrength",
|
|
3748
|
-
type: "string",
|
|
3749
|
-
description: "signal strength in the range [0, 4]",
|
|
3750
|
-
required: true
|
|
3751
3793
|
},
|
|
3752
|
-
{
|
|
3753
|
-
|
|
3754
|
-
type: "string",
|
|
3755
|
-
description: "signal strength in the range [0, 4]. Please also set this parameter with the same value if you use Appium v1.11.0 or lower (see https://github.com/appium/appium/issues/12234).",
|
|
3756
|
-
required: false
|
|
3794
|
+
windows: {
|
|
3795
|
+
Windows: "10+"
|
|
3757
3796
|
}
|
|
3758
|
-
|
|
3797
|
+
}
|
|
3798
|
+
}
|
|
3799
|
+
},
|
|
3800
|
+
"/session/:sessionId/appium/device/toggle_airplane_mode": {
|
|
3801
|
+
POST: {
|
|
3802
|
+
command: "toggleAirplaneMode",
|
|
3803
|
+
description: "Toggle airplane mode on device.",
|
|
3804
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/",
|
|
3805
|
+
parameters: [],
|
|
3759
3806
|
support: {
|
|
3760
3807
|
android: {
|
|
3761
3808
|
UiAutomator: "4.2+"
|
|
@@ -3763,19 +3810,12 @@ var appium_default = {
|
|
|
3763
3810
|
}
|
|
3764
3811
|
}
|
|
3765
3812
|
},
|
|
3766
|
-
"/session/:sessionId/appium/device/
|
|
3813
|
+
"/session/:sessionId/appium/device/toggle_data": {
|
|
3767
3814
|
POST: {
|
|
3768
|
-
command: "
|
|
3769
|
-
description: "
|
|
3770
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3771
|
-
parameters: [
|
|
3772
|
-
{
|
|
3773
|
-
name: "percent",
|
|
3774
|
-
type: "number",
|
|
3775
|
-
description: "percentage value in range [0, 100]",
|
|
3776
|
-
required: true
|
|
3777
|
-
}
|
|
3778
|
-
],
|
|
3815
|
+
command: "toggleData",
|
|
3816
|
+
description: "Switch the state of data service.",
|
|
3817
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/",
|
|
3818
|
+
parameters: [],
|
|
3779
3819
|
support: {
|
|
3780
3820
|
android: {
|
|
3781
3821
|
UiAutomator: "4.2+"
|
|
@@ -3783,19 +3823,12 @@ var appium_default = {
|
|
|
3783
3823
|
}
|
|
3784
3824
|
}
|
|
3785
3825
|
},
|
|
3786
|
-
"/session/:sessionId/appium/device/
|
|
3826
|
+
"/session/:sessionId/appium/device/toggle_wifi": {
|
|
3787
3827
|
POST: {
|
|
3788
|
-
command: "
|
|
3789
|
-
description: "
|
|
3790
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3791
|
-
parameters: [
|
|
3792
|
-
{
|
|
3793
|
-
name: "state",
|
|
3794
|
-
type: "string",
|
|
3795
|
-
description: "set the state. on or off",
|
|
3796
|
-
required: true
|
|
3797
|
-
}
|
|
3798
|
-
],
|
|
3828
|
+
command: "toggleWiFi",
|
|
3829
|
+
description: "Switch the state of the wifi service.",
|
|
3830
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/",
|
|
3831
|
+
parameters: [],
|
|
3799
3832
|
support: {
|
|
3800
3833
|
android: {
|
|
3801
3834
|
UiAutomator: "4.2+"
|
|
@@ -3803,19 +3836,12 @@ var appium_default = {
|
|
|
3803
3836
|
}
|
|
3804
3837
|
}
|
|
3805
3838
|
},
|
|
3806
|
-
"/session/:sessionId/appium/device/
|
|
3839
|
+
"/session/:sessionId/appium/device/toggle_location_services": {
|
|
3807
3840
|
POST: {
|
|
3808
|
-
command: "
|
|
3809
|
-
description: "
|
|
3810
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/
|
|
3811
|
-
parameters: [
|
|
3812
|
-
{
|
|
3813
|
-
name: "state",
|
|
3814
|
-
type: "string",
|
|
3815
|
-
description: "state of GSM voice - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'",
|
|
3816
|
-
required: true
|
|
3817
|
-
}
|
|
3818
|
-
],
|
|
3841
|
+
command: "toggleLocationServices",
|
|
3842
|
+
description: "Switch the state of the location service.",
|
|
3843
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/",
|
|
3844
|
+
parameters: [],
|
|
3819
3845
|
support: {
|
|
3820
3846
|
android: {
|
|
3821
3847
|
UiAutomator: "4.2+"
|
|
@@ -3823,22 +3849,16 @@ var appium_default = {
|
|
|
3823
3849
|
}
|
|
3824
3850
|
}
|
|
3825
3851
|
},
|
|
3826
|
-
"/session/:sessionId/appium/device/
|
|
3852
|
+
"/session/:sessionId/appium/device/network_speed": {
|
|
3827
3853
|
POST: {
|
|
3828
|
-
command: "
|
|
3829
|
-
description: "
|
|
3830
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/
|
|
3854
|
+
command: "toggleNetworkSpeed",
|
|
3855
|
+
description: "Set network speed (Emulator only)",
|
|
3856
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/",
|
|
3831
3857
|
parameters: [
|
|
3832
3858
|
{
|
|
3833
|
-
name: "
|
|
3834
|
-
type: "string",
|
|
3835
|
-
description: "the phone number to send the SMS too",
|
|
3836
|
-
required: true
|
|
3837
|
-
},
|
|
3838
|
-
{
|
|
3839
|
-
name: "message",
|
|
3859
|
+
name: "netspeed",
|
|
3840
3860
|
type: "string",
|
|
3841
|
-
description: "
|
|
3861
|
+
description: "Network type - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'",
|
|
3842
3862
|
required: true
|
|
3843
3863
|
}
|
|
3844
3864
|
],
|
|
@@ -3849,19 +3869,12 @@ var appium_default = {
|
|
|
3849
3869
|
}
|
|
3850
3870
|
}
|
|
3851
3871
|
},
|
|
3852
|
-
"/session/:sessionId/appium/device/
|
|
3872
|
+
"/session/:sessionId/appium/device/open_notifications": {
|
|
3853
3873
|
POST: {
|
|
3854
|
-
command: "
|
|
3855
|
-
description: "
|
|
3856
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3857
|
-
parameters: [
|
|
3858
|
-
{
|
|
3859
|
-
name: "fingerprintId",
|
|
3860
|
-
type: "number",
|
|
3861
|
-
description: "finger prints stored in Android Keystore system (from 1 to 10)",
|
|
3862
|
-
required: true
|
|
3863
|
-
}
|
|
3864
|
-
],
|
|
3874
|
+
command: "openNotifications",
|
|
3875
|
+
description: "Open Android notifications (Emulator only).",
|
|
3876
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/",
|
|
3877
|
+
parameters: [],
|
|
3865
3878
|
support: {
|
|
3866
3879
|
android: {
|
|
3867
3880
|
UiAutomator: "4.2+"
|
|
@@ -3869,429 +3882,446 @@ var appium_default = {
|
|
|
3869
3882
|
}
|
|
3870
3883
|
}
|
|
3871
3884
|
},
|
|
3872
|
-
"/session/:sessionId/appium/device/
|
|
3885
|
+
"/session/:sessionId/appium/device/start_activity": {
|
|
3873
3886
|
POST: {
|
|
3874
|
-
command: "
|
|
3875
|
-
description: "
|
|
3876
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3887
|
+
command: "startActivity",
|
|
3888
|
+
description: "Start an Android activity by providing package name and activity name.",
|
|
3889
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/",
|
|
3877
3890
|
parameters: [
|
|
3878
3891
|
{
|
|
3879
|
-
name: "
|
|
3892
|
+
name: "appPackage",
|
|
3880
3893
|
type: "string",
|
|
3881
|
-
description: "
|
|
3894
|
+
description: "name of app",
|
|
3882
3895
|
required: true
|
|
3883
3896
|
},
|
|
3884
3897
|
{
|
|
3885
|
-
name: "
|
|
3898
|
+
name: "appActivity",
|
|
3886
3899
|
type: "string",
|
|
3887
|
-
description: "
|
|
3900
|
+
description: "name of activity",
|
|
3901
|
+
required: true
|
|
3902
|
+
},
|
|
3903
|
+
{
|
|
3904
|
+
name: "appWaitPackage",
|
|
3905
|
+
type: "string",
|
|
3906
|
+
description: "name of app to wait for",
|
|
3888
3907
|
required: false
|
|
3889
3908
|
},
|
|
3890
3909
|
{
|
|
3891
|
-
name: "
|
|
3910
|
+
name: "appWaitActivity",
|
|
3892
3911
|
type: "string",
|
|
3893
|
-
description: "
|
|
3912
|
+
description: "name of activity to wait for",
|
|
3913
|
+
required: false
|
|
3914
|
+
},
|
|
3915
|
+
{
|
|
3916
|
+
name: "intentAction",
|
|
3917
|
+
type: "string",
|
|
3918
|
+
description: "intent action which will be used to start activity",
|
|
3919
|
+
required: false,
|
|
3920
|
+
default: "android.intent.action.MAIN"
|
|
3921
|
+
},
|
|
3922
|
+
{
|
|
3923
|
+
name: "intentCategory",
|
|
3924
|
+
type: "string",
|
|
3925
|
+
description: "intent category which will be used to start activity",
|
|
3926
|
+
required: false,
|
|
3927
|
+
default: "android.intent.category.LAUNCHER"
|
|
3928
|
+
},
|
|
3929
|
+
{
|
|
3930
|
+
name: "intentFlags",
|
|
3931
|
+
type: "string",
|
|
3932
|
+
description: "flags that will be used to start activity",
|
|
3933
|
+
required: false,
|
|
3934
|
+
default: "0x10200000"
|
|
3935
|
+
},
|
|
3936
|
+
{
|
|
3937
|
+
name: "optionalIntentArguments",
|
|
3938
|
+
type: "string",
|
|
3939
|
+
description: "additional intent arguments that will be used to start activity",
|
|
3940
|
+
required: false
|
|
3941
|
+
},
|
|
3942
|
+
{
|
|
3943
|
+
name: "dontStopAppOnReset",
|
|
3944
|
+
type: "string",
|
|
3945
|
+
description: "doesn\u2019t stop the process of the app under test, before starting the app using adb",
|
|
3894
3946
|
required: false
|
|
3895
3947
|
}
|
|
3896
3948
|
],
|
|
3949
|
+
support: {
|
|
3950
|
+
android: {
|
|
3951
|
+
UiAutomator: "4.2+"
|
|
3952
|
+
}
|
|
3953
|
+
}
|
|
3954
|
+
}
|
|
3955
|
+
},
|
|
3956
|
+
"/session/:sessionId/appium/device/system_bars": {
|
|
3957
|
+
GET: {
|
|
3958
|
+
command: "getSystemBars",
|
|
3959
|
+
description: "Retrieve visibility and bounds information of the status and navigation bars.",
|
|
3960
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/",
|
|
3961
|
+
parameters: [],
|
|
3897
3962
|
returns: {
|
|
3898
|
-
type: "
|
|
3899
|
-
name: "
|
|
3900
|
-
description: "
|
|
3963
|
+
type: "object[]",
|
|
3964
|
+
name: "systemBars",
|
|
3965
|
+
description: "Information about visibility and bounds of status and navigation bar"
|
|
3901
3966
|
},
|
|
3902
3967
|
support: {
|
|
3903
|
-
ios: {
|
|
3904
|
-
XCUITest: "9.3+"
|
|
3905
|
-
},
|
|
3906
3968
|
android: {
|
|
3907
3969
|
UiAutomator: "4.2+"
|
|
3908
3970
|
}
|
|
3909
3971
|
}
|
|
3910
3972
|
}
|
|
3911
3973
|
},
|
|
3912
|
-
"/session/:sessionId/appium/device/
|
|
3913
|
-
|
|
3914
|
-
command: "
|
|
3915
|
-
description: "Get the
|
|
3916
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/device/
|
|
3917
|
-
parameters: [
|
|
3918
|
-
{
|
|
3919
|
-
name: "contentType",
|
|
3920
|
-
type: "string",
|
|
3921
|
-
description: "The type of the content to get. Plaintext, Image, URL. Android supports only plaintext",
|
|
3922
|
-
required: false
|
|
3923
|
-
}
|
|
3924
|
-
],
|
|
3974
|
+
"/session/:sessionId/appium/device/system_time": {
|
|
3975
|
+
GET: {
|
|
3976
|
+
command: "getDeviceTime",
|
|
3977
|
+
description: "Get the time on the device.",
|
|
3978
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/system/system-time/",
|
|
3979
|
+
parameters: [],
|
|
3925
3980
|
returns: {
|
|
3926
3981
|
type: "string",
|
|
3927
|
-
name: "
|
|
3928
|
-
description: "
|
|
3982
|
+
name: "time",
|
|
3983
|
+
description: "Time on the device"
|
|
3929
3984
|
},
|
|
3930
3985
|
support: {
|
|
3931
3986
|
ios: {
|
|
3932
|
-
XCUITest: "9.3+"
|
|
3987
|
+
XCUITest: "9.3+",
|
|
3988
|
+
UIAutomation: "8.0 to 9.3"
|
|
3933
3989
|
},
|
|
3934
3990
|
android: {
|
|
3935
3991
|
UiAutomator: "4.2+"
|
|
3936
3992
|
}
|
|
3937
3993
|
}
|
|
3938
|
-
}
|
|
3939
|
-
},
|
|
3940
|
-
"/session/:sessionId/
|
|
3941
|
-
|
|
3942
|
-
command: "
|
|
3943
|
-
description: "
|
|
3944
|
-
ref: "https://
|
|
3945
|
-
parameters: [
|
|
3946
|
-
|
|
3947
|
-
|
|
3948
|
-
|
|
3949
|
-
|
|
3950
|
-
required: true
|
|
3951
|
-
}
|
|
3952
|
-
],
|
|
3953
|
-
examples: [
|
|
3954
|
-
[
|
|
3955
|
-
"// do a horizontal swipe by percentage",
|
|
3956
|
-
"const startPercentage = 10;",
|
|
3957
|
-
"const endPercentage = 90;",
|
|
3958
|
-
"const anchorPercentage = 50;",
|
|
3959
|
-
"",
|
|
3960
|
-
"const { width, height } = driver.getWindowSize();",
|
|
3961
|
-
"const anchor = height * anchorPercentage / 100;",
|
|
3962
|
-
"const startPoint = width * startPercentage / 100;",
|
|
3963
|
-
"const endPoint = width * endPercentage / 100;",
|
|
3964
|
-
"driver.touchPerform([",
|
|
3965
|
-
" {",
|
|
3966
|
-
" action: 'press',",
|
|
3967
|
-
" options: {",
|
|
3968
|
-
" x: startPoint,",
|
|
3969
|
-
" y: anchor,",
|
|
3970
|
-
" },",
|
|
3971
|
-
" },",
|
|
3972
|
-
" {",
|
|
3973
|
-
" action: 'wait',",
|
|
3974
|
-
" options: {",
|
|
3975
|
-
" ms: 100,",
|
|
3976
|
-
" },",
|
|
3977
|
-
" },",
|
|
3978
|
-
" {",
|
|
3979
|
-
" action: 'moveTo',",
|
|
3980
|
-
" options: {",
|
|
3981
|
-
" x: endPoint,",
|
|
3982
|
-
" y: anchor,",
|
|
3983
|
-
" },",
|
|
3984
|
-
" },",
|
|
3985
|
-
" {",
|
|
3986
|
-
" action: 'release',",
|
|
3987
|
-
" options: {},",
|
|
3988
|
-
" },",
|
|
3989
|
-
"]);"
|
|
3990
|
-
]
|
|
3991
|
-
],
|
|
3994
|
+
}
|
|
3995
|
+
},
|
|
3996
|
+
"/session/:sessionId/appium/device/display_density": {
|
|
3997
|
+
GET: {
|
|
3998
|
+
command: "getDisplayDensity",
|
|
3999
|
+
description: "Get display density from device.",
|
|
4000
|
+
ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
|
|
4001
|
+
parameters: [],
|
|
4002
|
+
returns: {
|
|
4003
|
+
type: "*",
|
|
4004
|
+
name: "displayDensity"
|
|
4005
|
+
},
|
|
3992
4006
|
support: {
|
|
3993
4007
|
android: {
|
|
3994
4008
|
UiAutomator: "4.2+"
|
|
3995
|
-
},
|
|
3996
|
-
ios: {
|
|
3997
|
-
XCUITest: "9.3+",
|
|
3998
|
-
UIAutomation: "8.0 to 9.3"
|
|
3999
|
-
},
|
|
4000
|
-
windows: {
|
|
4001
|
-
Windows: "10+"
|
|
4002
4009
|
}
|
|
4003
4010
|
}
|
|
4004
4011
|
}
|
|
4005
4012
|
},
|
|
4006
|
-
"/session/:sessionId/
|
|
4013
|
+
"/session/:sessionId/appium/simulator/touch_id": {
|
|
4007
4014
|
POST: {
|
|
4008
|
-
command: "
|
|
4009
|
-
description: "
|
|
4010
|
-
ref: "https://appium.github.io/appium.io/docs/en/commands/
|
|
4015
|
+
command: "touchId",
|
|
4016
|
+
description: "Simulate a [touch id](https://support.apple.com/en-ca/ht201371) event (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true and the Simulator must be [enrolled](https://support.apple.com/en-ca/ht201371). When you set allowTouchIdEnroll to true, it will set the Simulator to be enrolled by default. The enrollment state can be [toggled](https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/index.html). This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.",
|
|
4017
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/",
|
|
4011
4018
|
parameters: [
|
|
4012
4019
|
{
|
|
4013
|
-
name: "
|
|
4014
|
-
type: "
|
|
4015
|
-
description: "
|
|
4020
|
+
name: "match",
|
|
4021
|
+
type: "boolean",
|
|
4022
|
+
description: "are we simulating a successful touch (true) or a failed touch (false)",
|
|
4016
4023
|
required: true
|
|
4017
4024
|
}
|
|
4018
4025
|
],
|
|
4019
4026
|
support: {
|
|
4020
|
-
android: {
|
|
4021
|
-
UiAutomator: "4.2+"
|
|
4022
|
-
},
|
|
4023
4027
|
ios: {
|
|
4024
|
-
XCUITest: "9.3+"
|
|
4025
|
-
UIAutomation: "8.0 to 9.3"
|
|
4026
|
-
},
|
|
4027
|
-
windows: {
|
|
4028
|
-
Windows: "10+"
|
|
4028
|
+
XCUITest: "9.3+"
|
|
4029
4029
|
}
|
|
4030
4030
|
}
|
|
4031
4031
|
}
|
|
4032
4032
|
},
|
|
4033
|
-
"/session/:sessionId/appium/
|
|
4033
|
+
"/session/:sessionId/appium/simulator/toggle_touch_id_enrollment": {
|
|
4034
4034
|
POST: {
|
|
4035
|
-
command: "
|
|
4036
|
-
description: "
|
|
4037
|
-
ref: "https://github.
|
|
4035
|
+
command: "toggleEnrollTouchId",
|
|
4036
|
+
description: "Toggle the simulator being [enrolled](https://support.apple.com/en-ca/ht201371) to accept touchId (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true. When `allowTouchIdEnroll` is set to true the Simulator will be enrolled by default, and the 'Toggle Touch ID Enrollment' changes the enrollment state. This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.",
|
|
4037
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/",
|
|
4038
4038
|
parameters: [
|
|
4039
4039
|
{
|
|
4040
|
-
name: "
|
|
4041
|
-
type: "
|
|
4042
|
-
description: "
|
|
4043
|
-
required:
|
|
4040
|
+
name: "enabled",
|
|
4041
|
+
type: "boolean",
|
|
4042
|
+
description: "equals to true if TouchID enrollment should be enabled",
|
|
4043
|
+
required: false,
|
|
4044
|
+
default: true
|
|
4045
|
+
}
|
|
4046
|
+
],
|
|
4047
|
+
support: {
|
|
4048
|
+
ios: {
|
|
4049
|
+
XCUITest: "9.3+"
|
|
4050
|
+
}
|
|
4051
|
+
}
|
|
4052
|
+
}
|
|
4053
|
+
},
|
|
4054
|
+
"/session/:sessionId/appium/app/launch": {
|
|
4055
|
+
POST: {
|
|
4056
|
+
command: "launchApp",
|
|
4057
|
+
description: "Launch an app on device.",
|
|
4058
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/",
|
|
4059
|
+
deprecated: "For iOS, utilize `driver.execute('mobile: launchApp', { ... })`, and for Android, make use of `driver.execute('mobile: activateApp', { ... })`.",
|
|
4060
|
+
parameters: [],
|
|
4061
|
+
support: {
|
|
4062
|
+
ios: {
|
|
4063
|
+
XCUITest: "9.3+",
|
|
4064
|
+
UIAutomation: "8.0 to 9.3"
|
|
4044
4065
|
},
|
|
4045
|
-
{
|
|
4046
|
-
|
|
4047
|
-
|
|
4048
|
-
|
|
4049
|
-
|
|
4066
|
+
android: {
|
|
4067
|
+
UiAutomator: "4.2+"
|
|
4068
|
+
}
|
|
4069
|
+
}
|
|
4070
|
+
}
|
|
4071
|
+
},
|
|
4072
|
+
"/session/:sessionId/appium/app/close": {
|
|
4073
|
+
POST: {
|
|
4074
|
+
command: "closeApp",
|
|
4075
|
+
description: "Close an app on device.",
|
|
4076
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/",
|
|
4077
|
+
deprecated: "Use `driver.execute('mobile: terminateApp', { ... })` instead",
|
|
4078
|
+
parameters: [],
|
|
4079
|
+
support: {
|
|
4080
|
+
ios: {
|
|
4081
|
+
XCUITest: "9.3+",
|
|
4082
|
+
UIAutomation: "8.0 to 9.3"
|
|
4050
4083
|
},
|
|
4051
|
-
{
|
|
4052
|
-
|
|
4053
|
-
type: "number",
|
|
4054
|
-
description: "The number of milliseconds the script should be allowed to run before being killed by the Appium server. Defaults to the equivalent of 1 hour.",
|
|
4055
|
-
required: false
|
|
4084
|
+
android: {
|
|
4085
|
+
UiAutomator: "4.2+"
|
|
4056
4086
|
}
|
|
4057
|
-
],
|
|
4058
|
-
returns: {
|
|
4059
|
-
type: "object",
|
|
4060
|
-
name: "result",
|
|
4061
|
-
description: "An object containing two fields: 'result', which is the return value of the script itself, and 'logs', which contains 3 inner fields, 'log', 'warn', and 'error', which hold an array of strings logged by console.log, console.warn, and console.error in the script's execution."
|
|
4062
4087
|
}
|
|
4063
4088
|
}
|
|
4064
4089
|
},
|
|
4065
|
-
"/session/:sessionId/appium/
|
|
4090
|
+
"/session/:sessionId/appium/app/background": {
|
|
4066
4091
|
POST: {
|
|
4067
|
-
command: "
|
|
4068
|
-
description: "
|
|
4069
|
-
ref: "https://github.
|
|
4092
|
+
command: "background",
|
|
4093
|
+
description: "Send the currently running app for this session to the background.",
|
|
4094
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/",
|
|
4095
|
+
deprecated: "Use `driver.execute('mobile: backgroundApp', { ... })` instead",
|
|
4070
4096
|
parameters: [
|
|
4071
4097
|
{
|
|
4072
|
-
name: "
|
|
4073
|
-
type: "
|
|
4074
|
-
description: "
|
|
4075
|
-
required: true
|
|
4098
|
+
name: "seconds",
|
|
4099
|
+
type: "(number|null)",
|
|
4100
|
+
description: "timeout to restore app, if 'null' app won't be restored",
|
|
4101
|
+
required: true,
|
|
4102
|
+
default: "null"
|
|
4076
4103
|
}
|
|
4077
4104
|
],
|
|
4078
|
-
returns: {
|
|
4079
|
-
type: "object",
|
|
4080
|
-
name: "result",
|
|
4081
|
-
description: "A JSON hash of events like `{'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }`."
|
|
4082
|
-
},
|
|
4083
4105
|
support: {
|
|
4106
|
+
ios: {
|
|
4107
|
+
XCUITest: "9.3+",
|
|
4108
|
+
UIAutomation: "8.0 to 9.3"
|
|
4109
|
+
},
|
|
4084
4110
|
android: {
|
|
4085
4111
|
UiAutomator: "4.2+"
|
|
4086
|
-
},
|
|
4087
|
-
ios: {
|
|
4088
|
-
XCUITest: "9.3+"
|
|
4089
4112
|
}
|
|
4090
4113
|
}
|
|
4091
4114
|
}
|
|
4092
4115
|
},
|
|
4093
|
-
"/session/:sessionId/appium/
|
|
4116
|
+
"/session/:sessionId/appium/app/end_test_coverage": {
|
|
4094
4117
|
POST: {
|
|
4095
|
-
command: "
|
|
4096
|
-
description: "
|
|
4097
|
-
ref: "https://github.
|
|
4118
|
+
command: "endCoverage",
|
|
4119
|
+
description: "Get test coverage data.",
|
|
4120
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/end-test-coverage/",
|
|
4098
4121
|
parameters: [
|
|
4099
4122
|
{
|
|
4100
|
-
name: "
|
|
4123
|
+
name: "intent",
|
|
4101
4124
|
type: "string",
|
|
4102
|
-
description: "
|
|
4125
|
+
description: "intent to broadcast",
|
|
4103
4126
|
required: true
|
|
4104
4127
|
},
|
|
4105
4128
|
{
|
|
4106
|
-
name: "
|
|
4129
|
+
name: "path",
|
|
4107
4130
|
type: "string",
|
|
4108
|
-
description: "
|
|
4131
|
+
description: "path to .ec file",
|
|
4109
4132
|
required: true
|
|
4110
4133
|
}
|
|
4111
4134
|
],
|
|
4112
4135
|
support: {
|
|
4113
4136
|
android: {
|
|
4114
4137
|
UiAutomator: "4.2+"
|
|
4115
|
-
},
|
|
4116
|
-
ios: {
|
|
4117
|
-
XCUITest: "9.3+"
|
|
4118
4138
|
}
|
|
4119
4139
|
}
|
|
4120
4140
|
}
|
|
4121
4141
|
},
|
|
4122
|
-
"/session/:sessionId/appium/
|
|
4142
|
+
"/session/:sessionId/appium/app/strings": {
|
|
4123
4143
|
POST: {
|
|
4124
|
-
command: "
|
|
4125
|
-
description: "
|
|
4126
|
-
ref: "https://appium.github.io/appium.io/docs/en/
|
|
4144
|
+
command: "getStrings",
|
|
4145
|
+
description: "Get app strings.",
|
|
4146
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/",
|
|
4127
4147
|
parameters: [
|
|
4128
4148
|
{
|
|
4129
|
-
name: "
|
|
4130
|
-
type: "string",
|
|
4131
|
-
description: "One of possible comparison modes: 'matchFeatures', 'getSimilarity', 'matchTemplate'. 'matchFeatures' is by default.",
|
|
4132
|
-
required: true,
|
|
4133
|
-
default: "matchFeatures"
|
|
4134
|
-
},
|
|
4135
|
-
{
|
|
4136
|
-
name: "firstImage",
|
|
4149
|
+
name: "language",
|
|
4137
4150
|
type: "string",
|
|
4138
|
-
description: "
|
|
4139
|
-
required:
|
|
4151
|
+
description: "language code",
|
|
4152
|
+
required: false
|
|
4140
4153
|
},
|
|
4141
4154
|
{
|
|
4142
|
-
name: "
|
|
4155
|
+
name: "stringFile",
|
|
4143
4156
|
type: "string",
|
|
4144
|
-
description: "
|
|
4145
|
-
required:
|
|
4146
|
-
},
|
|
4147
|
-
{
|
|
4148
|
-
name: "options",
|
|
4149
|
-
type: "object",
|
|
4150
|
-
description: "The content of this dictionary depends on the actual `mode` value. See the documentation on `appium-support` module for more details. ",
|
|
4151
|
-
required: true,
|
|
4152
|
-
default: {}
|
|
4157
|
+
description: "path to the string file",
|
|
4158
|
+
required: false
|
|
4153
4159
|
}
|
|
4154
4160
|
],
|
|
4155
4161
|
returns: {
|
|
4156
4162
|
type: "object",
|
|
4157
|
-
name: "
|
|
4158
|
-
description: "
|
|
4159
|
-
}
|
|
4160
|
-
}
|
|
4161
|
-
},
|
|
4162
|
-
"/session/:sessionId/timeouts/implicit_wait": {
|
|
4163
|
-
POST: {
|
|
4164
|
-
command: "implicitWait",
|
|
4165
|
-
description: "Set the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list. If this command is never sent, the driver should default to an implicit wait of 0ms.",
|
|
4166
|
-
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4167
|
-
parameters: [
|
|
4168
|
-
{
|
|
4169
|
-
name: "ms",
|
|
4170
|
-
type: "number",
|
|
4171
|
-
description: "The amount of time, in milliseconds, to wait on an element.",
|
|
4172
|
-
required: true
|
|
4173
|
-
}
|
|
4174
|
-
],
|
|
4163
|
+
name: "appStrings",
|
|
4164
|
+
description: "all defined Strings from an app for the specified language and strings filename"
|
|
4165
|
+
},
|
|
4175
4166
|
support: {
|
|
4167
|
+
ios: {
|
|
4168
|
+
XCUITest: "9.3+",
|
|
4169
|
+
UIAutomation: "8.0 to 9.3"
|
|
4170
|
+
},
|
|
4176
4171
|
android: {
|
|
4177
4172
|
UiAutomator: "4.2+"
|
|
4178
|
-
},
|
|
4179
|
-
ios: {
|
|
4180
|
-
XCUITest: "9.3+"
|
|
4181
4173
|
}
|
|
4182
4174
|
}
|
|
4183
4175
|
}
|
|
4184
4176
|
},
|
|
4185
|
-
"/session/:sessionId/element/:elementId/
|
|
4186
|
-
|
|
4187
|
-
command: "
|
|
4188
|
-
|
|
4189
|
-
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4177
|
+
"/session/:sessionId/appium/element/:elementId/value": {
|
|
4178
|
+
POST: {
|
|
4179
|
+
command: "setValueImmediate",
|
|
4180
|
+
ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
|
|
4190
4181
|
variables: [
|
|
4191
4182
|
{
|
|
4192
4183
|
name: "elementId",
|
|
4193
|
-
description: "
|
|
4184
|
+
description: "the id of an element returned in a previous call to Find Element(s)"
|
|
4185
|
+
}
|
|
4186
|
+
],
|
|
4187
|
+
parameters: [
|
|
4188
|
+
{
|
|
4189
|
+
name: "text",
|
|
4190
|
+
type: "string",
|
|
4191
|
+
description: "text to set to an element",
|
|
4192
|
+
required: true
|
|
4194
4193
|
}
|
|
4195
4194
|
],
|
|
4196
|
-
parameters: [],
|
|
4197
|
-
returns: {
|
|
4198
|
-
type: "Object",
|
|
4199
|
-
name: "location",
|
|
4200
|
-
description: "The X and Y coordinates for the element on the page."
|
|
4201
|
-
},
|
|
4202
4195
|
support: {
|
|
4203
|
-
android: {
|
|
4204
|
-
UiAutomator: "4.2+"
|
|
4205
|
-
},
|
|
4206
4196
|
ios: {
|
|
4207
4197
|
XCUITest: "9.3+"
|
|
4198
|
+
},
|
|
4199
|
+
android: {
|
|
4200
|
+
UiAutomator: "4.2+"
|
|
4208
4201
|
}
|
|
4209
4202
|
}
|
|
4210
4203
|
}
|
|
4211
4204
|
},
|
|
4212
|
-
"/session/:sessionId/
|
|
4205
|
+
"/session/:sessionId/appium/element/:elementId/replace_value": {
|
|
4213
4206
|
POST: {
|
|
4214
|
-
command: "
|
|
4215
|
-
description: "
|
|
4216
|
-
ref: "https://github.com/appium/appium/blob/master/
|
|
4207
|
+
command: "replaceValue",
|
|
4208
|
+
description: "Replace the value to element directly.",
|
|
4209
|
+
ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
|
|
4210
|
+
variables: [
|
|
4211
|
+
{
|
|
4212
|
+
name: "elementId",
|
|
4213
|
+
description: "the id of an element returned in a previous call to Find Element(s)"
|
|
4214
|
+
}
|
|
4215
|
+
],
|
|
4217
4216
|
parameters: [
|
|
4218
4217
|
{
|
|
4219
4218
|
name: "value",
|
|
4220
|
-
type: "string
|
|
4221
|
-
description: "
|
|
4219
|
+
type: "string",
|
|
4220
|
+
description: "value to replace on element",
|
|
4222
4221
|
required: true
|
|
4223
4222
|
}
|
|
4224
4223
|
],
|
|
4225
4224
|
support: {
|
|
4225
|
+
ios: {
|
|
4226
|
+
XCUITest: "9.3+",
|
|
4227
|
+
UIAutomation: "8.0 to 9.3"
|
|
4228
|
+
},
|
|
4226
4229
|
android: {
|
|
4227
4230
|
UiAutomator: "4.2+"
|
|
4228
|
-
},
|
|
4229
|
-
ios: {
|
|
4230
|
-
XCUITest: "9.3+"
|
|
4231
4231
|
}
|
|
4232
4232
|
}
|
|
4233
4233
|
}
|
|
4234
4234
|
},
|
|
4235
|
-
"/session/:sessionId/
|
|
4235
|
+
"/session/:sessionId/appium/settings": {
|
|
4236
4236
|
GET: {
|
|
4237
|
-
command: "
|
|
4238
|
-
description: "
|
|
4239
|
-
ref: "https://github.
|
|
4237
|
+
command: "getSettings",
|
|
4238
|
+
description: "Retrieve the current settings on the device.",
|
|
4239
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/session/settings/get-settings/",
|
|
4240
4240
|
parameters: [],
|
|
4241
4241
|
returns: {
|
|
4242
|
-
type: "
|
|
4243
|
-
name: "
|
|
4244
|
-
description: "
|
|
4242
|
+
type: "object",
|
|
4243
|
+
name: "settings",
|
|
4244
|
+
description: "JSON hash of all the currently specified settings, see Settings API"
|
|
4245
4245
|
},
|
|
4246
4246
|
support: {
|
|
4247
|
+
ios: {
|
|
4248
|
+
XCUITest: "9.3+",
|
|
4249
|
+
UIAutomation: "8.0 to 9.3"
|
|
4250
|
+
},
|
|
4247
4251
|
android: {
|
|
4248
4252
|
UiAutomator: "4.2+"
|
|
4253
|
+
},
|
|
4254
|
+
windows: {
|
|
4255
|
+
Windows: "10+"
|
|
4249
4256
|
}
|
|
4250
4257
|
}
|
|
4251
|
-
}
|
|
4252
|
-
|
|
4253
|
-
|
|
4254
|
-
|
|
4255
|
-
|
|
4256
|
-
|
|
4257
|
-
|
|
4258
|
-
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
|
|
4262
|
-
|
|
4263
|
-
|
|
4258
|
+
},
|
|
4259
|
+
POST: {
|
|
4260
|
+
command: "updateSettings",
|
|
4261
|
+
description: "Update the current setting on the device.",
|
|
4262
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/session/settings/update-settings/",
|
|
4263
|
+
parameters: [
|
|
4264
|
+
{
|
|
4265
|
+
name: "settings",
|
|
4266
|
+
type: "object",
|
|
4267
|
+
description: "key/value object with settings to update",
|
|
4268
|
+
required: true
|
|
4269
|
+
}
|
|
4270
|
+
],
|
|
4264
4271
|
support: {
|
|
4272
|
+
ios: {
|
|
4273
|
+
XCUITest: "9.3+",
|
|
4274
|
+
UIAutomation: "8.0 to 9.3"
|
|
4275
|
+
},
|
|
4265
4276
|
android: {
|
|
4266
4277
|
UiAutomator: "4.2+"
|
|
4278
|
+
},
|
|
4279
|
+
windows: {
|
|
4280
|
+
Windows: "10+"
|
|
4267
4281
|
}
|
|
4268
4282
|
}
|
|
4269
4283
|
}
|
|
4270
4284
|
},
|
|
4271
|
-
"/session/:sessionId/
|
|
4272
|
-
|
|
4273
|
-
command: "
|
|
4274
|
-
description: "
|
|
4275
|
-
ref: "https://github.com/appium/appium/blob/master/
|
|
4276
|
-
parameters: [
|
|
4277
|
-
|
|
4278
|
-
|
|
4279
|
-
|
|
4280
|
-
|
|
4281
|
-
|
|
4285
|
+
"/session/:sessionId/appium/receive_async_response": {
|
|
4286
|
+
POST: {
|
|
4287
|
+
command: "receiveAsyncResponse",
|
|
4288
|
+
description: "Callback url for asynchronous execution of JavaScript.",
|
|
4289
|
+
ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
|
|
4290
|
+
parameters: [
|
|
4291
|
+
{
|
|
4292
|
+
name: "response",
|
|
4293
|
+
type: "object",
|
|
4294
|
+
description: "response to receive on device",
|
|
4295
|
+
required: true
|
|
4296
|
+
}
|
|
4297
|
+
],
|
|
4282
4298
|
support: {
|
|
4283
|
-
|
|
4284
|
-
|
|
4299
|
+
ios: {
|
|
4300
|
+
XCUITest: "9.3+",
|
|
4301
|
+
UIAutomation: "8.0 to 9.3"
|
|
4285
4302
|
}
|
|
4286
4303
|
}
|
|
4287
4304
|
}
|
|
4288
4305
|
},
|
|
4289
|
-
"/session/:sessionId/
|
|
4306
|
+
"/session/:sessionId/appium/device/gsm_call": {
|
|
4290
4307
|
POST: {
|
|
4291
|
-
command: "
|
|
4292
|
-
description: "
|
|
4293
|
-
ref: "https://github.
|
|
4294
|
-
parameters: [
|
|
4308
|
+
command: "gsmCall",
|
|
4309
|
+
description: "Make GSM call (Emulator only).",
|
|
4310
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/",
|
|
4311
|
+
parameters: [
|
|
4312
|
+
{
|
|
4313
|
+
name: "phoneNumber",
|
|
4314
|
+
type: "string",
|
|
4315
|
+
description: "the phone number to call to",
|
|
4316
|
+
required: true
|
|
4317
|
+
},
|
|
4318
|
+
{
|
|
4319
|
+
name: "action",
|
|
4320
|
+
type: "string",
|
|
4321
|
+
description: "The action - 'call', 'accept', 'cancel', 'hold'",
|
|
4322
|
+
required: true
|
|
4323
|
+
}
|
|
4324
|
+
],
|
|
4295
4325
|
support: {
|
|
4296
4326
|
android: {
|
|
4297
4327
|
UiAutomator: "4.2+"
|
|
@@ -4299,17 +4329,23 @@ var appium_default = {
|
|
|
4299
4329
|
}
|
|
4300
4330
|
}
|
|
4301
4331
|
},
|
|
4302
|
-
"/session/:sessionId/
|
|
4332
|
+
"/session/:sessionId/appium/device/gsm_signal": {
|
|
4303
4333
|
POST: {
|
|
4304
|
-
command: "
|
|
4305
|
-
description: "
|
|
4306
|
-
ref: "https://github.
|
|
4334
|
+
command: "gsmSignal",
|
|
4335
|
+
description: "Set GSM signal strength (Emulator only).",
|
|
4336
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/",
|
|
4307
4337
|
parameters: [
|
|
4308
4338
|
{
|
|
4309
|
-
name: "
|
|
4339
|
+
name: "signalStrength",
|
|
4310
4340
|
type: "string",
|
|
4311
|
-
description: "
|
|
4341
|
+
description: "signal strength in the range [0, 4]",
|
|
4312
4342
|
required: true
|
|
4343
|
+
},
|
|
4344
|
+
{
|
|
4345
|
+
name: "signalStrengh",
|
|
4346
|
+
type: "string",
|
|
4347
|
+
description: "signal strength in the range [0, 4]. Please also set this parameter with the same value if you use Appium v1.11.0 or lower (see https://github.com/appium/appium/issues/12234).",
|
|
4348
|
+
required: false
|
|
4313
4349
|
}
|
|
4314
4350
|
],
|
|
4315
4351
|
support: {
|
|
@@ -4319,281 +4355,352 @@ var appium_default = {
|
|
|
4319
4355
|
}
|
|
4320
4356
|
}
|
|
4321
4357
|
},
|
|
4322
|
-
"/session/:sessionId/
|
|
4358
|
+
"/session/:sessionId/appium/device/power_capacity": {
|
|
4323
4359
|
POST: {
|
|
4324
|
-
command: "
|
|
4325
|
-
description: "Set the
|
|
4326
|
-
ref: "https://github.
|
|
4360
|
+
command: "powerCapacity",
|
|
4361
|
+
description: "Set the battery percentage (Emulator only).",
|
|
4362
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/",
|
|
4327
4363
|
parameters: [
|
|
4328
4364
|
{
|
|
4329
|
-
name: "
|
|
4365
|
+
name: "percent",
|
|
4330
4366
|
type: "number",
|
|
4331
|
-
description: "
|
|
4367
|
+
description: "percentage value in range [0, 100]",
|
|
4332
4368
|
required: true
|
|
4333
4369
|
}
|
|
4334
4370
|
],
|
|
4335
4371
|
support: {
|
|
4336
|
-
|
|
4337
|
-
|
|
4372
|
+
android: {
|
|
4373
|
+
UiAutomator: "4.2+"
|
|
4338
4374
|
}
|
|
4339
4375
|
}
|
|
4340
4376
|
}
|
|
4341
4377
|
},
|
|
4342
|
-
"/session/:sessionId/
|
|
4378
|
+
"/session/:sessionId/appium/device/power_ac": {
|
|
4343
4379
|
POST: {
|
|
4344
|
-
command: "
|
|
4345
|
-
description: "
|
|
4346
|
-
ref: "https://github.
|
|
4347
|
-
|
|
4380
|
+
command: "powerAC",
|
|
4381
|
+
description: "Set the state of the battery charger to connected or not (Emulator only).",
|
|
4382
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/",
|
|
4383
|
+
parameters: [
|
|
4348
4384
|
{
|
|
4349
|
-
name: "
|
|
4350
|
-
|
|
4385
|
+
name: "state",
|
|
4386
|
+
type: "string",
|
|
4387
|
+
description: "set the state. on or off",
|
|
4388
|
+
required: true
|
|
4351
4389
|
}
|
|
4352
4390
|
],
|
|
4353
|
-
parameters: [],
|
|
4354
4391
|
support: {
|
|
4355
|
-
|
|
4356
|
-
|
|
4392
|
+
android: {
|
|
4393
|
+
UiAutomator: "4.2+"
|
|
4357
4394
|
}
|
|
4358
4395
|
}
|
|
4359
4396
|
}
|
|
4360
4397
|
},
|
|
4361
|
-
"/session/:sessionId/
|
|
4362
|
-
|
|
4363
|
-
command: "
|
|
4364
|
-
description: "
|
|
4365
|
-
ref: "https://github.
|
|
4366
|
-
|
|
4398
|
+
"/session/:sessionId/appium/device/gsm_voice": {
|
|
4399
|
+
POST: {
|
|
4400
|
+
command: "gsmVoice",
|
|
4401
|
+
description: "Set GSM voice state (Emulator only).",
|
|
4402
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/",
|
|
4403
|
+
parameters: [
|
|
4367
4404
|
{
|
|
4368
|
-
name: "
|
|
4369
|
-
|
|
4405
|
+
name: "state",
|
|
4406
|
+
type: "string",
|
|
4407
|
+
description: "state of GSM voice - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'",
|
|
4408
|
+
required: true
|
|
4370
4409
|
}
|
|
4371
4410
|
],
|
|
4372
|
-
parameters: [],
|
|
4373
|
-
returns: {
|
|
4374
|
-
type: "Object",
|
|
4375
|
-
name: "size",
|
|
4376
|
-
description: "The width and height of the element, in pixels."
|
|
4377
|
-
},
|
|
4378
4411
|
support: {
|
|
4379
4412
|
android: {
|
|
4380
4413
|
UiAutomator: "4.2+"
|
|
4381
|
-
},
|
|
4382
|
-
ios: {
|
|
4383
|
-
XCUITest: "9.3+"
|
|
4384
4414
|
}
|
|
4385
4415
|
}
|
|
4386
4416
|
}
|
|
4387
4417
|
},
|
|
4388
|
-
"/session/:sessionId/
|
|
4389
|
-
|
|
4390
|
-
command: "
|
|
4391
|
-
description: "
|
|
4392
|
-
ref: "https://github.
|
|
4393
|
-
|
|
4418
|
+
"/session/:sessionId/appium/device/send_sms": {
|
|
4419
|
+
POST: {
|
|
4420
|
+
command: "sendSms",
|
|
4421
|
+
description: "Simulate an SMS message (Emulator only).",
|
|
4422
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/",
|
|
4423
|
+
parameters: [
|
|
4394
4424
|
{
|
|
4395
|
-
name: "
|
|
4396
|
-
|
|
4425
|
+
name: "phoneNumber",
|
|
4426
|
+
type: "string",
|
|
4427
|
+
description: "the phone number to send the SMS too",
|
|
4428
|
+
required: true
|
|
4429
|
+
},
|
|
4430
|
+
{
|
|
4431
|
+
name: "message",
|
|
4432
|
+
type: "string",
|
|
4433
|
+
description: "the SMS message",
|
|
4434
|
+
required: true
|
|
4397
4435
|
}
|
|
4398
4436
|
],
|
|
4399
|
-
parameters: [],
|
|
4400
|
-
returns: {
|
|
4401
|
-
type: "Object",
|
|
4402
|
-
name: "location",
|
|
4403
|
-
description: "The X and Y coordinates for the element on the page."
|
|
4404
|
-
},
|
|
4405
4437
|
support: {
|
|
4406
4438
|
android: {
|
|
4407
4439
|
UiAutomator: "4.2+"
|
|
4408
|
-
},
|
|
4409
|
-
ios: {
|
|
4410
|
-
XCUITest: "9.3+"
|
|
4411
4440
|
}
|
|
4412
4441
|
}
|
|
4413
4442
|
}
|
|
4414
4443
|
},
|
|
4415
|
-
"/session/:sessionId/
|
|
4444
|
+
"/session/:sessionId/appium/device/finger_print": {
|
|
4416
4445
|
POST: {
|
|
4417
|
-
command: "
|
|
4418
|
-
description: "
|
|
4419
|
-
ref: "https://github.
|
|
4446
|
+
command: "fingerPrint",
|
|
4447
|
+
description: "Authenticate users by using their finger print scans on supported emulators.",
|
|
4448
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/",
|
|
4420
4449
|
parameters: [
|
|
4421
4450
|
{
|
|
4422
|
-
name: "
|
|
4423
|
-
type: "
|
|
4424
|
-
description: "
|
|
4451
|
+
name: "fingerprintId",
|
|
4452
|
+
type: "number",
|
|
4453
|
+
description: "finger prints stored in Android Keystore system (from 1 to 10)",
|
|
4425
4454
|
required: true
|
|
4426
4455
|
}
|
|
4427
4456
|
],
|
|
4428
4457
|
support: {
|
|
4429
4458
|
android: {
|
|
4430
4459
|
UiAutomator: "4.2+"
|
|
4431
|
-
},
|
|
4432
|
-
ios: {
|
|
4433
|
-
XCUITest: "9.3+"
|
|
4434
4460
|
}
|
|
4435
4461
|
}
|
|
4436
4462
|
}
|
|
4437
4463
|
},
|
|
4438
|
-
"/session/:sessionId/
|
|
4464
|
+
"/session/:sessionId/appium/device/set_clipboard": {
|
|
4439
4465
|
POST: {
|
|
4440
|
-
command: "
|
|
4441
|
-
description: "
|
|
4442
|
-
ref: "https://github.
|
|
4466
|
+
command: "setClipboard",
|
|
4467
|
+
description: "Set the content of the system clipboard",
|
|
4468
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/",
|
|
4443
4469
|
parameters: [
|
|
4444
4470
|
{
|
|
4445
|
-
name: "
|
|
4446
|
-
type: "
|
|
4447
|
-
description: "
|
|
4471
|
+
name: "content",
|
|
4472
|
+
type: "string",
|
|
4473
|
+
description: "The actual base64 encoded clipboard content",
|
|
4448
4474
|
required: true
|
|
4449
4475
|
},
|
|
4450
4476
|
{
|
|
4451
|
-
name: "
|
|
4452
|
-
type: "
|
|
4453
|
-
description: "
|
|
4454
|
-
required:
|
|
4477
|
+
name: "contentType",
|
|
4478
|
+
type: "string",
|
|
4479
|
+
description: "The type of the content to get. Plaintext, Image, URL. Android supports only plaintext",
|
|
4480
|
+
required: false
|
|
4481
|
+
},
|
|
4482
|
+
{
|
|
4483
|
+
name: "label",
|
|
4484
|
+
type: "string",
|
|
4485
|
+
description: "Clipboard data label for Android",
|
|
4486
|
+
required: false
|
|
4455
4487
|
}
|
|
4456
4488
|
],
|
|
4489
|
+
returns: {
|
|
4490
|
+
type: "string",
|
|
4491
|
+
name: "response",
|
|
4492
|
+
description: "Response from Appium server"
|
|
4493
|
+
},
|
|
4457
4494
|
support: {
|
|
4495
|
+
ios: {
|
|
4496
|
+
XCUITest: "9.3+"
|
|
4497
|
+
},
|
|
4458
4498
|
android: {
|
|
4459
4499
|
UiAutomator: "4.2+"
|
|
4460
4500
|
}
|
|
4461
4501
|
}
|
|
4462
4502
|
}
|
|
4463
4503
|
},
|
|
4464
|
-
"/session/:sessionId/
|
|
4504
|
+
"/session/:sessionId/appium/device/get_clipboard": {
|
|
4465
4505
|
POST: {
|
|
4466
|
-
command: "
|
|
4467
|
-
description: "
|
|
4468
|
-
ref: "https://github.
|
|
4506
|
+
command: "getClipboard",
|
|
4507
|
+
description: "Get the content of the system clipboard",
|
|
4508
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/",
|
|
4469
4509
|
parameters: [
|
|
4470
4510
|
{
|
|
4471
|
-
name: "
|
|
4472
|
-
type: "
|
|
4473
|
-
description: "
|
|
4474
|
-
required:
|
|
4475
|
-
},
|
|
4476
|
-
{
|
|
4477
|
-
name: "y",
|
|
4478
|
-
type: "number",
|
|
4479
|
-
description: "y coordinate on the screen",
|
|
4480
|
-
required: true
|
|
4511
|
+
name: "contentType",
|
|
4512
|
+
type: "string",
|
|
4513
|
+
description: "The type of the content to get. Plaintext, Image, URL. Android supports only plaintext",
|
|
4514
|
+
required: false
|
|
4481
4515
|
}
|
|
4482
4516
|
],
|
|
4517
|
+
returns: {
|
|
4518
|
+
type: "string",
|
|
4519
|
+
name: "response",
|
|
4520
|
+
description: "Clipboard content as base64-encoded string or an empty string if the clipboard is empty"
|
|
4521
|
+
},
|
|
4483
4522
|
support: {
|
|
4523
|
+
ios: {
|
|
4524
|
+
XCUITest: "9.3+"
|
|
4525
|
+
},
|
|
4484
4526
|
android: {
|
|
4485
4527
|
UiAutomator: "4.2+"
|
|
4486
4528
|
}
|
|
4487
4529
|
}
|
|
4488
4530
|
}
|
|
4489
4531
|
},
|
|
4490
|
-
"/session/:sessionId/touch/
|
|
4532
|
+
"/session/:sessionId/touch/perform": {
|
|
4491
4533
|
POST: {
|
|
4492
|
-
command: "
|
|
4493
|
-
description: "
|
|
4494
|
-
ref: "https://github.
|
|
4534
|
+
command: "touchPerform",
|
|
4535
|
+
description: "This functionality is only available from within a native context. 'Touch Perform' works similarly to the other singular touch interactions, except that this allows you to chain together more than one touch action as one command. This is useful because Appium commands are sent over the network and there's latency between commands. This latency can make certain touch interactions impossible because some interactions need to be performed in one sequence. Vertical, for example, requires pressing down, moving to a different y coordinate, and then releasing. For it to work, there can't be a delay between the interactions.",
|
|
4536
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/interactions/touch/touch-perform/",
|
|
4495
4537
|
parameters: [
|
|
4496
4538
|
{
|
|
4497
|
-
name: "
|
|
4498
|
-
type: "
|
|
4499
|
-
description: "
|
|
4500
|
-
required: true
|
|
4501
|
-
},
|
|
4502
|
-
{
|
|
4503
|
-
name: "y",
|
|
4504
|
-
type: "number",
|
|
4505
|
-
description: "y coordinate on the screen",
|
|
4539
|
+
name: "actions",
|
|
4540
|
+
type: "object[]",
|
|
4541
|
+
description: "The type of action to perform (e.g. moveTo, release, press, tap, wait)",
|
|
4506
4542
|
required: true
|
|
4507
4543
|
}
|
|
4508
4544
|
],
|
|
4545
|
+
examples: [
|
|
4546
|
+
[
|
|
4547
|
+
"// do a horizontal swipe by percentage",
|
|
4548
|
+
"const startPercentage = 10;",
|
|
4549
|
+
"const endPercentage = 90;",
|
|
4550
|
+
"const anchorPercentage = 50;",
|
|
4551
|
+
"",
|
|
4552
|
+
"const { width, height } = driver.getWindowSize();",
|
|
4553
|
+
"const anchor = height * anchorPercentage / 100;",
|
|
4554
|
+
"const startPoint = width * startPercentage / 100;",
|
|
4555
|
+
"const endPoint = width * endPercentage / 100;",
|
|
4556
|
+
"driver.touchPerform([",
|
|
4557
|
+
" {",
|
|
4558
|
+
" action: 'press',",
|
|
4559
|
+
" options: {",
|
|
4560
|
+
" x: startPoint,",
|
|
4561
|
+
" y: anchor,",
|
|
4562
|
+
" },",
|
|
4563
|
+
" },",
|
|
4564
|
+
" {",
|
|
4565
|
+
" action: 'wait',",
|
|
4566
|
+
" options: {",
|
|
4567
|
+
" ms: 100,",
|
|
4568
|
+
" },",
|
|
4569
|
+
" },",
|
|
4570
|
+
" {",
|
|
4571
|
+
" action: 'moveTo',",
|
|
4572
|
+
" options: {",
|
|
4573
|
+
" x: endPoint,",
|
|
4574
|
+
" y: anchor,",
|
|
4575
|
+
" },",
|
|
4576
|
+
" },",
|
|
4577
|
+
" {",
|
|
4578
|
+
" action: 'release',",
|
|
4579
|
+
" options: {},",
|
|
4580
|
+
" },",
|
|
4581
|
+
"]);"
|
|
4582
|
+
]
|
|
4583
|
+
],
|
|
4509
4584
|
support: {
|
|
4510
4585
|
android: {
|
|
4511
4586
|
UiAutomator: "4.2+"
|
|
4587
|
+
},
|
|
4588
|
+
ios: {
|
|
4589
|
+
XCUITest: "9.3+",
|
|
4590
|
+
UIAutomation: "8.0 to 9.3"
|
|
4591
|
+
},
|
|
4592
|
+
windows: {
|
|
4593
|
+
Windows: "10+"
|
|
4512
4594
|
}
|
|
4513
4595
|
}
|
|
4514
4596
|
}
|
|
4515
4597
|
},
|
|
4516
|
-
"/session/:sessionId/touch/
|
|
4598
|
+
"/session/:sessionId/touch/multi/perform": {
|
|
4517
4599
|
POST: {
|
|
4518
|
-
command: "
|
|
4519
|
-
description: "
|
|
4520
|
-
ref: "https://github.
|
|
4600
|
+
command: "multiTouchPerform",
|
|
4601
|
+
description: "This functionality is only available from within a native context. Perform a multi touch action sequence.",
|
|
4602
|
+
ref: "https://appium.github.io/appium.io/docs/en/commands/interactions/touch/multi-touch-perform/",
|
|
4521
4603
|
parameters: [
|
|
4522
4604
|
{
|
|
4523
|
-
name: "
|
|
4524
|
-
type: "
|
|
4525
|
-
description: "
|
|
4605
|
+
name: "actions",
|
|
4606
|
+
type: "object[]",
|
|
4607
|
+
description: "The type of action to perform (e.g. moveTo, release, press, tap, wait)",
|
|
4526
4608
|
required: true
|
|
4527
4609
|
}
|
|
4528
4610
|
],
|
|
4529
4611
|
support: {
|
|
4530
4612
|
android: {
|
|
4531
4613
|
UiAutomator: "4.2+"
|
|
4614
|
+
},
|
|
4615
|
+
ios: {
|
|
4616
|
+
XCUITest: "9.3+",
|
|
4617
|
+
UIAutomation: "8.0 to 9.3"
|
|
4618
|
+
},
|
|
4619
|
+
windows: {
|
|
4620
|
+
Windows: "10+"
|
|
4532
4621
|
}
|
|
4533
4622
|
}
|
|
4534
4623
|
}
|
|
4535
4624
|
},
|
|
4536
|
-
"/session/:sessionId/
|
|
4625
|
+
"/session/:sessionId/appium/execute_driver": {
|
|
4537
4626
|
POST: {
|
|
4538
|
-
command: "
|
|
4539
|
-
description: "
|
|
4540
|
-
ref: "https://github.com/appium/appium/blob/master/
|
|
4627
|
+
command: "executeDriverScript",
|
|
4628
|
+
description: "This command enables you to specify a WebdriverIO script as a string and transmit it to the Appium server for local execution on the server itself. This approach helps minimize potential latency associated with each command. ***To utilize this command with Appium 2.0, you must have the [`execute-driver-plugin`](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin installed.***",
|
|
4629
|
+
ref: "https://github.com/appium/appium/blob/master/docs/en/commands/session/execute-driver.md",
|
|
4541
4630
|
parameters: [
|
|
4542
4631
|
{
|
|
4543
|
-
name: "
|
|
4544
|
-
type: "number",
|
|
4545
|
-
description: "the x offset in pixels to flick by",
|
|
4546
|
-
required: false
|
|
4547
|
-
},
|
|
4548
|
-
{
|
|
4549
|
-
name: "yoffset",
|
|
4550
|
-
type: "number",
|
|
4551
|
-
description: "the y offset in pixels to flick by",
|
|
4552
|
-
required: false
|
|
4553
|
-
},
|
|
4554
|
-
{
|
|
4555
|
-
name: "element",
|
|
4632
|
+
name: "script",
|
|
4556
4633
|
type: "string",
|
|
4557
|
-
description: "
|
|
4558
|
-
required:
|
|
4634
|
+
description: "The script to execute. It has access to a 'driver' object which represents a WebdriverIO session attached to the current server.",
|
|
4635
|
+
required: true
|
|
4559
4636
|
},
|
|
4560
4637
|
{
|
|
4561
|
-
name: "
|
|
4562
|
-
type: "
|
|
4563
|
-
description: "
|
|
4638
|
+
name: "type",
|
|
4639
|
+
type: "string",
|
|
4640
|
+
description: "The language/framework used in the script. Currently, only 'webdriverio' is supported and is the default.",
|
|
4564
4641
|
required: false
|
|
4565
4642
|
},
|
|
4566
4643
|
{
|
|
4567
|
-
name: "
|
|
4644
|
+
name: "timeout",
|
|
4568
4645
|
type: "number",
|
|
4569
|
-
description: "the
|
|
4646
|
+
description: "The number of milliseconds the script should be allowed to run before being killed by the Appium server. Defaults to the equivalent of 1 hour.",
|
|
4570
4647
|
required: false
|
|
4571
|
-
}
|
|
4648
|
+
}
|
|
4649
|
+
],
|
|
4650
|
+
returns: {
|
|
4651
|
+
type: "object",
|
|
4652
|
+
name: "result",
|
|
4653
|
+
description: "An object containing two fields: 'result', which is the return value of the script itself, and 'logs', which contains 3 inner fields, 'log', 'warn', and 'error', which hold an array of strings logged by console.log, console.warn, and console.error in the script's execution."
|
|
4654
|
+
}
|
|
4655
|
+
}
|
|
4656
|
+
},
|
|
4657
|
+
"/session/:sessionId/appium/events": {
|
|
4658
|
+
POST: {
|
|
4659
|
+
command: "getEvents",
|
|
4660
|
+
description: "Get events stored in appium server.",
|
|
4661
|
+
ref: "https://github.com/appium/appium/blob/master/docs/en/commands/session/events/get-events.md",
|
|
4662
|
+
parameters: [
|
|
4572
4663
|
{
|
|
4573
|
-
name: "
|
|
4574
|
-
type: "
|
|
4575
|
-
description: "the
|
|
4576
|
-
required:
|
|
4664
|
+
name: "type",
|
|
4665
|
+
type: "string[]",
|
|
4666
|
+
description: "Get events which are filtered with the type if the type is provided.",
|
|
4667
|
+
required: true
|
|
4577
4668
|
}
|
|
4578
4669
|
],
|
|
4670
|
+
returns: {
|
|
4671
|
+
type: "object",
|
|
4672
|
+
name: "result",
|
|
4673
|
+
description: "A JSON hash of events like `{'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }`."
|
|
4674
|
+
},
|
|
4579
4675
|
support: {
|
|
4580
4676
|
android: {
|
|
4581
4677
|
UiAutomator: "4.2+"
|
|
4678
|
+
},
|
|
4679
|
+
ios: {
|
|
4680
|
+
XCUITest: "9.3+"
|
|
4582
4681
|
}
|
|
4583
4682
|
}
|
|
4584
4683
|
}
|
|
4585
4684
|
},
|
|
4586
|
-
"/session/:sessionId/
|
|
4587
|
-
|
|
4588
|
-
command: "
|
|
4589
|
-
description: "
|
|
4590
|
-
ref: "https://github.com/appium/appium/blob/master/
|
|
4591
|
-
parameters: [
|
|
4592
|
-
|
|
4593
|
-
|
|
4594
|
-
|
|
4595
|
-
|
|
4596
|
-
|
|
4685
|
+
"/session/:sessionId/appium/log_event": {
|
|
4686
|
+
POST: {
|
|
4687
|
+
command: "logEvent",
|
|
4688
|
+
description: "Store a custom event.",
|
|
4689
|
+
ref: "https://github.com/appium/appium/blob/master/docs/en/commands/session/events/log-event.md",
|
|
4690
|
+
parameters: [
|
|
4691
|
+
{
|
|
4692
|
+
name: "vendor",
|
|
4693
|
+
type: "string",
|
|
4694
|
+
description: "The name of vendor. It will be `vendor` in `vendor:event`.",
|
|
4695
|
+
required: true
|
|
4696
|
+
},
|
|
4697
|
+
{
|
|
4698
|
+
name: "event",
|
|
4699
|
+
type: "string",
|
|
4700
|
+
description: "The name of event. It will be `event` in `vendor:event`.",
|
|
4701
|
+
required: true
|
|
4702
|
+
}
|
|
4703
|
+
],
|
|
4597
4704
|
support: {
|
|
4598
4705
|
android: {
|
|
4599
4706
|
UiAutomator: "4.2+"
|
|
@@ -4602,47 +4709,61 @@ var appium_default = {
|
|
|
4602
4709
|
XCUITest: "9.3+"
|
|
4603
4710
|
}
|
|
4604
4711
|
}
|
|
4605
|
-
}
|
|
4712
|
+
}
|
|
4713
|
+
},
|
|
4714
|
+
"/session/:sessionId/appium/compare_images": {
|
|
4606
4715
|
POST: {
|
|
4607
|
-
command: "
|
|
4608
|
-
description: "
|
|
4609
|
-
ref: "https://github.
|
|
4716
|
+
command: "compareImages",
|
|
4717
|
+
description: "This feature conducts image comparisons utilizing the capabilities of the OpenCV framework. Please note that for this functionality to work, both the OpenCV framework and the opencv4nodejs module must be installed on the machine where the Appium server is operational. ***Furthermore, you'll need to have the [`images-plugin`](https://github.com/appium/appium/tree/master/packages/images-plugin) plugin installed to use this feature with Appium 2.0.***",
|
|
4718
|
+
ref: "https://appium.github.io/appium.io/docs/en/writing-running-appium/image-comparison/",
|
|
4610
4719
|
parameters: [
|
|
4611
4720
|
{
|
|
4612
|
-
name: "
|
|
4721
|
+
name: "mode",
|
|
4613
4722
|
type: "string",
|
|
4614
|
-
description: "
|
|
4723
|
+
description: "One of possible comparison modes: 'matchFeatures', 'getSimilarity', 'matchTemplate'. 'matchFeatures' is by default.",
|
|
4724
|
+
required: true,
|
|
4725
|
+
default: "matchFeatures"
|
|
4726
|
+
},
|
|
4727
|
+
{
|
|
4728
|
+
name: "firstImage",
|
|
4729
|
+
type: "string",
|
|
4730
|
+
description: "An image data. All image formats, that OpenCV library itself accepts, are supported.",
|
|
4615
4731
|
required: true
|
|
4616
|
-
}
|
|
4617
|
-
],
|
|
4618
|
-
support: {
|
|
4619
|
-
android: {
|
|
4620
|
-
UiAutomator: "4.2+"
|
|
4621
4732
|
},
|
|
4622
|
-
|
|
4623
|
-
|
|
4733
|
+
{
|
|
4734
|
+
name: "secondImage",
|
|
4735
|
+
type: "string",
|
|
4736
|
+
description: "An image data. All image formats, that OpenCV library itself accepts, are supported.",
|
|
4737
|
+
required: true
|
|
4738
|
+
},
|
|
4739
|
+
{
|
|
4740
|
+
name: "options",
|
|
4741
|
+
type: "object",
|
|
4742
|
+
description: "The content of this dictionary depends on the actual `mode` value. See the documentation on `appium-support` module for more details. ",
|
|
4743
|
+
required: true,
|
|
4744
|
+
default: {}
|
|
4624
4745
|
}
|
|
4746
|
+
],
|
|
4747
|
+
returns: {
|
|
4748
|
+
type: "object",
|
|
4749
|
+
name: "result",
|
|
4750
|
+
description: "The content of the resulting dictionary depends on the actual `mode` and `options` values. See the documentation on `appium-support` module for more details."
|
|
4625
4751
|
}
|
|
4626
4752
|
}
|
|
4627
4753
|
},
|
|
4628
|
-
"/session/:sessionId/
|
|
4754
|
+
"/session/:sessionId/timeouts/implicit_wait": {
|
|
4629
4755
|
POST: {
|
|
4630
|
-
command: "
|
|
4631
|
-
description: "
|
|
4756
|
+
command: "implicitWait",
|
|
4757
|
+
description: "Set the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list. If this command is never sent, the driver should default to an implicit wait of 0ms.",
|
|
4632
4758
|
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4633
4759
|
parameters: [
|
|
4634
4760
|
{
|
|
4635
|
-
name: "
|
|
4636
|
-
type: "
|
|
4637
|
-
description: "
|
|
4761
|
+
name: "ms",
|
|
4762
|
+
type: "number",
|
|
4763
|
+
description: "The amount of time, in milliseconds, to wait on an element.",
|
|
4638
4764
|
required: true
|
|
4639
4765
|
}
|
|
4640
4766
|
],
|
|
4641
|
-
returns: {
|
|
4642
|
-
type: "Object[]",
|
|
4643
|
-
name: "logs",
|
|
4644
|
-
description: "The list of log entries."
|
|
4645
|
-
},
|
|
4646
4767
|
support: {
|
|
4647
4768
|
android: {
|
|
4648
4769
|
UiAutomator: "4.2+"
|
|
@@ -4653,16 +4774,22 @@ var appium_default = {
|
|
|
4653
4774
|
}
|
|
4654
4775
|
}
|
|
4655
4776
|
},
|
|
4656
|
-
"/session/:sessionId/
|
|
4777
|
+
"/session/:sessionId/element/:elementId/location_in_view": {
|
|
4657
4778
|
GET: {
|
|
4658
|
-
command: "
|
|
4659
|
-
description: "
|
|
4779
|
+
command: "getLocationInView",
|
|
4780
|
+
description: "Determine an element's location on the screen once it has been scrolled into view.<br /><br />__Note:__ This is considered an internal command and should only be used to determine an element's location for correctly generating native events.",
|
|
4660
4781
|
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4782
|
+
variables: [
|
|
4783
|
+
{
|
|
4784
|
+
name: "elementId",
|
|
4785
|
+
description: "ID of the element to route the command to"
|
|
4786
|
+
}
|
|
4787
|
+
],
|
|
4661
4788
|
parameters: [],
|
|
4662
4789
|
returns: {
|
|
4663
|
-
type: "
|
|
4664
|
-
name: "
|
|
4665
|
-
description: "The
|
|
4790
|
+
type: "Object",
|
|
4791
|
+
name: "location",
|
|
4792
|
+
description: "The X and Y coordinates for the element on the page."
|
|
4666
4793
|
},
|
|
4667
4794
|
support: {
|
|
4668
4795
|
android: {
|
|
@@ -4673,537 +4800,447 @@ var appium_default = {
|
|
|
4673
4800
|
}
|
|
4674
4801
|
}
|
|
4675
4802
|
}
|
|
4676
|
-
}
|
|
4677
|
-
};
|
|
4678
|
-
|
|
4679
|
-
// src/protocols/chromium.ts
|
|
4680
|
-
var chromium_default = {
|
|
4681
|
-
"/session/:sessionId/alert": {
|
|
4682
|
-
GET: {
|
|
4683
|
-
command: "isAlertOpen",
|
|
4684
|
-
description: "Whether a simple dialog is currently open.",
|
|
4685
|
-
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/alert_commands.cc#L42-L49",
|
|
4686
|
-
examples: [
|
|
4687
|
-
[
|
|
4688
|
-
"console.log(browser.isAlertOpen()); // outputs: false",
|
|
4689
|
-
"browser.execute('window.alert()');",
|
|
4690
|
-
"console.log(browser.isAlertOpen()); // outputs: true"
|
|
4691
|
-
]
|
|
4692
|
-
],
|
|
4693
|
-
parameters: [],
|
|
4694
|
-
returns: {
|
|
4695
|
-
type: "Boolean",
|
|
4696
|
-
name: "isAlertOpen",
|
|
4697
|
-
description: "`true` or `false` based on whether simple dialog is present or not."
|
|
4698
|
-
}
|
|
4699
|
-
}
|
|
4700
4803
|
},
|
|
4701
|
-
"/session/:sessionId/
|
|
4702
|
-
GET: {
|
|
4703
|
-
command: "isAutoReporting",
|
|
4704
|
-
description: "Whether it should automatically raises errors on browser logs.",
|
|
4705
|
-
ref: "https://codereview.chromium.org/101203012",
|
|
4706
|
-
parameters: [],
|
|
4707
|
-
returns: {
|
|
4708
|
-
type: "Boolean",
|
|
4709
|
-
name: "isAutoReporting",
|
|
4710
|
-
description: "`true` or `false` based on whether auto reporting is enabled."
|
|
4711
|
-
}
|
|
4712
|
-
},
|
|
4804
|
+
"/session/:sessionId/keys": {
|
|
4713
4805
|
POST: {
|
|
4714
|
-
command: "
|
|
4715
|
-
description: "
|
|
4716
|
-
ref: "https://
|
|
4717
|
-
examples: [
|
|
4718
|
-
[
|
|
4719
|
-
"// Enable auto reporting first thing after session was initiated with empty browser logs",
|
|
4720
|
-
"console.log(browser.setAutoReporting(true)); // outputs: null",
|
|
4721
|
-
"// Upon requesting an non-existing resource it will abort execution due to thrown unknown error",
|
|
4722
|
-
"browser.url('https://webdriver.io/img/404-does-not-exist.png');"
|
|
4723
|
-
],
|
|
4724
|
-
[
|
|
4725
|
-
"// During the session do some operations which populate the browser logs",
|
|
4726
|
-
"browser.url('https://webdriver.io/img/404-does-not-exist.png');",
|
|
4727
|
-
"browser.url('https://webdriver.io/403/no-access');",
|
|
4728
|
-
"// Enable auto reporting which throws an unknown error for first browser log (404 response)",
|
|
4729
|
-
"browser.setAutoReporting(true);"
|
|
4730
|
-
]
|
|
4731
|
-
],
|
|
4806
|
+
command: "sendKeys",
|
|
4807
|
+
description: "Send a sequence of key strokes to the active element",
|
|
4808
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4732
4809
|
parameters: [
|
|
4733
4810
|
{
|
|
4734
|
-
name: "
|
|
4735
|
-
type: "
|
|
4736
|
-
description: "
|
|
4811
|
+
name: "value",
|
|
4812
|
+
type: "string[]",
|
|
4813
|
+
description: "The sequence of keys to type. An array must be provided.",
|
|
4737
4814
|
required: true
|
|
4738
4815
|
}
|
|
4739
4816
|
],
|
|
4740
|
-
|
|
4741
|
-
|
|
4742
|
-
|
|
4743
|
-
|
|
4817
|
+
support: {
|
|
4818
|
+
android: {
|
|
4819
|
+
UiAutomator: "4.2+"
|
|
4820
|
+
},
|
|
4821
|
+
ios: {
|
|
4822
|
+
XCUITest: "9.3+"
|
|
4823
|
+
}
|
|
4744
4824
|
}
|
|
4745
4825
|
}
|
|
4746
4826
|
},
|
|
4747
|
-
"/session/:sessionId/
|
|
4827
|
+
"/session/:sessionId/ime/available_engines": {
|
|
4748
4828
|
GET: {
|
|
4749
|
-
command: "
|
|
4750
|
-
description: "
|
|
4751
|
-
ref: "https://github.com/
|
|
4752
|
-
examples: [
|
|
4753
|
-
[
|
|
4754
|
-
"console.log(browser.isLoading()); // outputs: false",
|
|
4755
|
-
"browser.newWindow('https://webdriver.io');",
|
|
4756
|
-
"console.log(browser.isLoading()); // outputs: true"
|
|
4757
|
-
]
|
|
4758
|
-
],
|
|
4829
|
+
command: "availableIMEEngines",
|
|
4830
|
+
description: "List all available engines on the machine. To use an engine, it has to be present in this list.",
|
|
4831
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4759
4832
|
parameters: [],
|
|
4760
4833
|
returns: {
|
|
4761
|
-
type: "
|
|
4762
|
-
name: "
|
|
4763
|
-
description: "
|
|
4834
|
+
type: "String[]",
|
|
4835
|
+
name: "engines",
|
|
4836
|
+
description: "A list of available engines"
|
|
4837
|
+
},
|
|
4838
|
+
support: {
|
|
4839
|
+
android: {
|
|
4840
|
+
UiAutomator: "4.2+"
|
|
4841
|
+
}
|
|
4764
4842
|
}
|
|
4765
4843
|
}
|
|
4766
4844
|
},
|
|
4767
|
-
"/session/:sessionId/
|
|
4845
|
+
"/session/:sessionId/ime/active_engine": {
|
|
4768
4846
|
GET: {
|
|
4769
|
-
command: "
|
|
4770
|
-
description: "
|
|
4771
|
-
ref: "https://github.com/
|
|
4847
|
+
command: "getActiveIMEEngine",
|
|
4848
|
+
description: "Get the name of the active IME engine. The name string is platform specific.",
|
|
4849
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4772
4850
|
parameters: [],
|
|
4773
4851
|
returns: {
|
|
4774
|
-
type: "
|
|
4775
|
-
name: "
|
|
4776
|
-
description: "
|
|
4852
|
+
type: "String",
|
|
4853
|
+
name: "engine",
|
|
4854
|
+
description: "The name of the active IME engine"
|
|
4855
|
+
},
|
|
4856
|
+
support: {
|
|
4857
|
+
android: {
|
|
4858
|
+
UiAutomator: "4.2+"
|
|
4859
|
+
}
|
|
4777
4860
|
}
|
|
4778
4861
|
}
|
|
4779
4862
|
},
|
|
4780
|
-
"/session/:sessionId/
|
|
4863
|
+
"/session/:sessionId/ime/activated": {
|
|
4781
4864
|
GET: {
|
|
4782
|
-
command: "
|
|
4783
|
-
description: "
|
|
4784
|
-
ref: "https://github.com/
|
|
4785
|
-
examples: [
|
|
4786
|
-
[
|
|
4787
|
-
"const browser = remote({",
|
|
4788
|
-
" capabilities: {",
|
|
4789
|
-
" browserName: 'chrome',",
|
|
4790
|
-
" 'goog:chromeOptions': {",
|
|
4791
|
-
" // Network emulation requires device mode, which is only enabled when mobile emulation is on",
|
|
4792
|
-
" mobileEmulation: { deviceName: 'iPad' },",
|
|
4793
|
-
" },",
|
|
4794
|
-
" }",
|
|
4795
|
-
"});",
|
|
4796
|
-
"console.log(browser.getNetworkConnection()); // outputs: 6 (Both Wi-Fi and data)"
|
|
4797
|
-
]
|
|
4798
|
-
],
|
|
4865
|
+
command: "isIMEActivated",
|
|
4866
|
+
description: "Indicates whether IME input is active at the moment",
|
|
4867
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4799
4868
|
parameters: [],
|
|
4800
4869
|
returns: {
|
|
4801
|
-
type: "
|
|
4802
|
-
name: "
|
|
4803
|
-
description: "
|
|
4804
|
-
}
|
|
4805
|
-
|
|
4806
|
-
|
|
4807
|
-
|
|
4808
|
-
description: "Change connection type for network connection. This command is only applicable when remote end replies with `networkConnectionEnabled` capability set to `true`.",
|
|
4809
|
-
ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes",
|
|
4810
|
-
examples: [
|
|
4811
|
-
[
|
|
4812
|
-
"const browser = remote({",
|
|
4813
|
-
" capabilities: {",
|
|
4814
|
-
" browserName: 'chrome',",
|
|
4815
|
-
" 'goog:chromeOptions': {",
|
|
4816
|
-
" // Network emulation requires device mode, which is only enabled when mobile emulation is on",
|
|
4817
|
-
" mobileEmulation: { deviceName: 'iPad' },",
|
|
4818
|
-
" },",
|
|
4819
|
-
" }",
|
|
4820
|
-
"});",
|
|
4821
|
-
"console.log(browser.setNetworkConnection({ type: 1 })); // outputs: 1 (Airplane Mode)"
|
|
4822
|
-
]
|
|
4823
|
-
],
|
|
4824
|
-
parameters: [
|
|
4825
|
-
{
|
|
4826
|
-
name: "parameters",
|
|
4827
|
-
type: "object",
|
|
4828
|
-
description: "Object containing ConnectionType, set bitmask as value for `type` key in object. Airplane Mode (`1`), Wi-Fi only (`2`), Wi-Fi and data (`6`), 4G (`8`), 3G (`10`), 2G (`20`).",
|
|
4829
|
-
required: true
|
|
4870
|
+
type: "Boolean",
|
|
4871
|
+
name: "isActive",
|
|
4872
|
+
description: "true if IME input is available and currently active, false otherwise"
|
|
4873
|
+
},
|
|
4874
|
+
support: {
|
|
4875
|
+
android: {
|
|
4876
|
+
UiAutomator: "4.2+"
|
|
4830
4877
|
}
|
|
4831
|
-
],
|
|
4832
|
-
returns: {
|
|
4833
|
-
type: "Number",
|
|
4834
|
-
name: "connectionType",
|
|
4835
|
-
description: "A bitmask to represent the network connection type. Value should match specified `type` in object, however device might not be capable of the network connection type requested."
|
|
4836
4878
|
}
|
|
4837
4879
|
}
|
|
4838
4880
|
},
|
|
4839
|
-
"/session/:sessionId/
|
|
4840
|
-
GET: {
|
|
4841
|
-
command: "getNetworkConditions",
|
|
4842
|
-
description: "Get current network conditions used for emulation.",
|
|
4843
|
-
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L839-L859",
|
|
4844
|
-
parameters: [],
|
|
4845
|
-
returns: {
|
|
4846
|
-
type: "Object",
|
|
4847
|
-
name: "networkConditions",
|
|
4848
|
-
description: "Object containing network conditions for `offline`, `latency`, `download_throughput` and `upload_throughput`. Network conditions must be set before it can be retrieved."
|
|
4849
|
-
}
|
|
4850
|
-
},
|
|
4881
|
+
"/session/:sessionId/ime/deactivate": {
|
|
4851
4882
|
POST: {
|
|
4852
|
-
command: "
|
|
4853
|
-
description: "
|
|
4854
|
-
ref: "https://github.com/
|
|
4855
|
-
|
|
4856
|
-
|
|
4857
|
-
|
|
4858
|
-
|
|
4859
|
-
],
|
|
4860
|
-
[
|
|
4861
|
-
"// Force disconnected from network by setting 'offline' to true",
|
|
4862
|
-
"browser.setNetworkConditions({ latency: 0, throughput: 0, offline: true });"
|
|
4863
|
-
],
|
|
4864
|
-
[
|
|
4865
|
-
"// When preset name (e.g. 'DSL') is specified it does not respect values in object (e.g. 'offline')",
|
|
4866
|
-
"browser.setNetworkConditions({ latency: 0, throughput: 0, offline: true }, 'DSL');"
|
|
4867
|
-
],
|
|
4868
|
-
[
|
|
4869
|
-
"// Best practice for specifying network throttling preset is to use an empty object",
|
|
4870
|
-
"browser.setNetworkConditions({}, 'Good 3G');"
|
|
4871
|
-
]
|
|
4872
|
-
],
|
|
4873
|
-
parameters: [
|
|
4874
|
-
{
|
|
4875
|
-
name: "network_conditions",
|
|
4876
|
-
type: "object",
|
|
4877
|
-
description: "Object containing network conditions which are `latency`, `throughput` (or `download_throughput`/`upload_throughput`) and `offline` (optional).",
|
|
4878
|
-
required: true
|
|
4879
|
-
},
|
|
4880
|
-
{
|
|
4881
|
-
name: "network_name",
|
|
4882
|
-
type: "string",
|
|
4883
|
-
description: "Name of [network throttling preset](https://github.com/bayandin/chromedriver/blob/v2.45/chrome/network_list.cc#L12-L25). `GPRS`, `Regular 2G`, `Good 2G`, `Regular 3G`, `Good 3G`, `Regular 4G`, `DSL`, `WiFi` or `No throttling` to disable. When preset is specified values passed in first argument are not respected.",
|
|
4884
|
-
required: false
|
|
4883
|
+
command: "deactivateIMEEngine",
|
|
4884
|
+
description: "De-activates the currently-active IME engine.",
|
|
4885
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4886
|
+
parameters: [],
|
|
4887
|
+
support: {
|
|
4888
|
+
android: {
|
|
4889
|
+
UiAutomator: "4.2+"
|
|
4885
4890
|
}
|
|
4886
|
-
|
|
4887
|
-
},
|
|
4888
|
-
DELETE: {
|
|
4889
|
-
command: "deleteNetworkConditions",
|
|
4890
|
-
description: "Disable any network throttling which might have been set. Equivalent of setting the `No throttling` preset.",
|
|
4891
|
-
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L1724-L1745",
|
|
4892
|
-
parameters: []
|
|
4891
|
+
}
|
|
4893
4892
|
}
|
|
4894
4893
|
},
|
|
4895
|
-
"/session/:sessionId/
|
|
4894
|
+
"/session/:sessionId/ime/activate": {
|
|
4896
4895
|
POST: {
|
|
4897
|
-
command: "
|
|
4898
|
-
description: "
|
|
4899
|
-
ref: "https://github.com/
|
|
4896
|
+
command: "activateIMEEngine",
|
|
4897
|
+
description: "Make an engines that is available",
|
|
4898
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4900
4899
|
parameters: [
|
|
4901
4900
|
{
|
|
4902
|
-
name: "
|
|
4901
|
+
name: "engine",
|
|
4903
4902
|
type: "string",
|
|
4904
|
-
description: "
|
|
4905
|
-
required: true
|
|
4906
|
-
},
|
|
4907
|
-
{
|
|
4908
|
-
name: "params",
|
|
4909
|
-
type: "object",
|
|
4910
|
-
description: "Parameters to the command. In case no parameters for command, specify an empty object.",
|
|
4903
|
+
description: "name of the engine to activate",
|
|
4911
4904
|
required: true
|
|
4912
4905
|
}
|
|
4913
|
-
]
|
|
4906
|
+
],
|
|
4907
|
+
support: {
|
|
4908
|
+
android: {
|
|
4909
|
+
UiAutomator: "4.2+"
|
|
4910
|
+
}
|
|
4911
|
+
}
|
|
4914
4912
|
}
|
|
4915
4913
|
},
|
|
4916
|
-
"/session/:sessionId/
|
|
4914
|
+
"/session/:sessionId/timeouts/async_script": {
|
|
4917
4915
|
POST: {
|
|
4918
|
-
command: "
|
|
4919
|
-
description: "
|
|
4920
|
-
ref: "https://github.com/
|
|
4916
|
+
command: "asyncScriptTimeout",
|
|
4917
|
+
description: "Set the amount of time, in milliseconds, that asynchronous scripts executed by `/session/:sessionId/execute_async` are permitted to run before they are aborted and a `Timeout` error is returned to the client.",
|
|
4918
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4921
4919
|
parameters: [
|
|
4922
4920
|
{
|
|
4923
|
-
name: "
|
|
4924
|
-
type: "
|
|
4925
|
-
description: "
|
|
4926
|
-
required: true
|
|
4927
|
-
},
|
|
4928
|
-
{
|
|
4929
|
-
name: "params",
|
|
4930
|
-
type: "object",
|
|
4931
|
-
description: "Parameters to the command. In case no parameters for command, specify an empty object.",
|
|
4921
|
+
name: "ms",
|
|
4922
|
+
type: "number",
|
|
4923
|
+
description: "The amount of time, in milliseconds, that time-limited commands are permitted to run",
|
|
4932
4924
|
required: true
|
|
4933
4925
|
}
|
|
4934
4926
|
],
|
|
4935
|
-
|
|
4936
|
-
|
|
4937
|
-
|
|
4938
|
-
|
|
4927
|
+
support: {
|
|
4928
|
+
ios: {
|
|
4929
|
+
XCUITest: "9.3+"
|
|
4930
|
+
}
|
|
4939
4931
|
}
|
|
4940
4932
|
}
|
|
4941
4933
|
},
|
|
4942
|
-
"/session/:sessionId/
|
|
4934
|
+
"/session/:sessionId/element/:elementId/submit": {
|
|
4943
4935
|
POST: {
|
|
4944
|
-
command: "
|
|
4945
|
-
description: "
|
|
4946
|
-
ref: "https://github.com/
|
|
4947
|
-
|
|
4936
|
+
command: "submit",
|
|
4937
|
+
description: "Submit a form element.",
|
|
4938
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4939
|
+
variables: [
|
|
4948
4940
|
{
|
|
4949
|
-
name: "
|
|
4950
|
-
|
|
4951
|
-
description: "Base64-encoded zip archive containing __single__ file which to upload. In case base64-encoded data does not represent a zip archive or archive contains more than one file it will throw an unknown error.",
|
|
4952
|
-
required: true
|
|
4941
|
+
name: "elementId",
|
|
4942
|
+
description: "ID of the form element to be submitted"
|
|
4953
4943
|
}
|
|
4954
4944
|
],
|
|
4955
|
-
|
|
4956
|
-
|
|
4957
|
-
|
|
4958
|
-
|
|
4945
|
+
parameters: [],
|
|
4946
|
+
support: {
|
|
4947
|
+
ios: {
|
|
4948
|
+
XCUITest: "9.3+"
|
|
4949
|
+
}
|
|
4959
4950
|
}
|
|
4960
4951
|
}
|
|
4961
4952
|
},
|
|
4962
|
-
"/session/:sessionId/
|
|
4963
|
-
|
|
4964
|
-
command: "
|
|
4965
|
-
description: "
|
|
4966
|
-
ref: "https://github.com/
|
|
4967
|
-
|
|
4968
|
-
[
|
|
4969
|
-
"import fs from 'fs'",
|
|
4970
|
-
"const browser = remote({",
|
|
4971
|
-
" capabilities: {",
|
|
4972
|
-
" browserName: 'chrome',",
|
|
4973
|
-
" 'goog:chromeOptions': {",
|
|
4974
|
-
" // Install upon starting browser in order to launch it",
|
|
4975
|
-
" extensions: [",
|
|
4976
|
-
" // Entry should be a base64-encoded packed Chrome app (.crx)",
|
|
4977
|
-
" fs.readFileSync('/absolute/path/app.crx').toString('base64')",
|
|
4978
|
-
" ]",
|
|
4979
|
-
" }",
|
|
4980
|
-
" }",
|
|
4981
|
-
"});",
|
|
4982
|
-
"browser.launchChromeApp('aohghmighlieiainnegkcijnfilokake')); // Google Docs (https://chrome.google.com/webstore/detail/docs/aohghmighlieiainnegkcijnfilokake)"
|
|
4983
|
-
]
|
|
4984
|
-
],
|
|
4985
|
-
parameters: [
|
|
4953
|
+
"/session/:sessionId/element/:elementId/size": {
|
|
4954
|
+
GET: {
|
|
4955
|
+
command: "getElementSize",
|
|
4956
|
+
description: "Determine an element's size in pixels. The size will be returned as a JSON object with `width` and `height` properties.",
|
|
4957
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
4958
|
+
variables: [
|
|
4986
4959
|
{
|
|
4987
|
-
name: "
|
|
4988
|
-
|
|
4989
|
-
description: "Extension id of app to be launched, as defined in chrome://extensions.",
|
|
4990
|
-
required: true
|
|
4960
|
+
name: "elementId",
|
|
4961
|
+
description: "ID of the element to route the command to"
|
|
4991
4962
|
}
|
|
4992
|
-
]
|
|
4963
|
+
],
|
|
4964
|
+
parameters: [],
|
|
4965
|
+
returns: {
|
|
4966
|
+
type: "Object",
|
|
4967
|
+
name: "size",
|
|
4968
|
+
description: "The width and height of the element, in pixels."
|
|
4969
|
+
},
|
|
4970
|
+
support: {
|
|
4971
|
+
android: {
|
|
4972
|
+
UiAutomator: "4.2+"
|
|
4973
|
+
},
|
|
4974
|
+
ios: {
|
|
4975
|
+
XCUITest: "9.3+"
|
|
4976
|
+
}
|
|
4977
|
+
}
|
|
4993
4978
|
}
|
|
4994
4979
|
},
|
|
4995
|
-
"/session/:sessionId/element/:elementId/
|
|
4980
|
+
"/session/:sessionId/element/:elementId/location": {
|
|
4996
4981
|
GET: {
|
|
4997
|
-
command: "
|
|
4998
|
-
description: "
|
|
4999
|
-
ref: "https://github.com/
|
|
4982
|
+
command: "getElementLocation",
|
|
4983
|
+
description: "Determine an element's location on the page. The point `(0, 0)` refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with `x` and `y` properties.",
|
|
4984
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5000
4985
|
variables: [
|
|
5001
4986
|
{
|
|
5002
4987
|
name: "elementId",
|
|
5003
|
-
description: "
|
|
4988
|
+
description: "ID of the element to route the command to"
|
|
5004
4989
|
}
|
|
5005
4990
|
],
|
|
5006
4991
|
parameters: [],
|
|
5007
4992
|
returns: {
|
|
5008
|
-
type: "
|
|
5009
|
-
name: "
|
|
5010
|
-
description: "
|
|
4993
|
+
type: "Object",
|
|
4994
|
+
name: "location",
|
|
4995
|
+
description: "The X and Y coordinates for the element on the page."
|
|
4996
|
+
},
|
|
4997
|
+
support: {
|
|
4998
|
+
android: {
|
|
4999
|
+
UiAutomator: "4.2+"
|
|
5000
|
+
},
|
|
5001
|
+
ios: {
|
|
5002
|
+
XCUITest: "9.3+"
|
|
5003
|
+
}
|
|
5011
5004
|
}
|
|
5012
5005
|
}
|
|
5013
5006
|
},
|
|
5014
|
-
"/session/:sessionId/
|
|
5007
|
+
"/session/:sessionId/touch/click": {
|
|
5015
5008
|
POST: {
|
|
5016
|
-
command: "
|
|
5017
|
-
description: "
|
|
5018
|
-
ref: "https://github.com/
|
|
5019
|
-
|
|
5009
|
+
command: "touchClick",
|
|
5010
|
+
description: "Single tap on the touch enabled device.",
|
|
5011
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5012
|
+
parameters: [
|
|
5013
|
+
{
|
|
5014
|
+
name: "element",
|
|
5015
|
+
type: "string",
|
|
5016
|
+
description: "ID of the element to single tap on.",
|
|
5017
|
+
required: true
|
|
5018
|
+
}
|
|
5019
|
+
],
|
|
5020
|
+
support: {
|
|
5021
|
+
android: {
|
|
5022
|
+
UiAutomator: "4.2+"
|
|
5023
|
+
},
|
|
5024
|
+
ios: {
|
|
5025
|
+
XCUITest: "9.3+"
|
|
5026
|
+
}
|
|
5027
|
+
}
|
|
5028
|
+
}
|
|
5029
|
+
},
|
|
5030
|
+
"/session/:sessionId/touch/down": {
|
|
5031
|
+
POST: {
|
|
5032
|
+
command: "touchDown",
|
|
5033
|
+
description: "Finger down on the screen.",
|
|
5034
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5035
|
+
parameters: [
|
|
5036
|
+
{
|
|
5037
|
+
name: "x",
|
|
5038
|
+
type: "number",
|
|
5039
|
+
description: "x coordinate on the screen",
|
|
5040
|
+
required: true
|
|
5041
|
+
},
|
|
5020
5042
|
{
|
|
5021
|
-
name: "
|
|
5022
|
-
|
|
5043
|
+
name: "y",
|
|
5044
|
+
type: "number",
|
|
5045
|
+
description: "y coordinate on the screen",
|
|
5046
|
+
required: true
|
|
5023
5047
|
}
|
|
5024
5048
|
],
|
|
5025
|
-
|
|
5049
|
+
support: {
|
|
5050
|
+
android: {
|
|
5051
|
+
UiAutomator: "4.2+"
|
|
5052
|
+
}
|
|
5053
|
+
}
|
|
5026
5054
|
}
|
|
5027
5055
|
},
|
|
5028
|
-
"/session/:sessionId/touch/
|
|
5056
|
+
"/session/:sessionId/touch/up": {
|
|
5029
5057
|
POST: {
|
|
5030
|
-
command: "
|
|
5031
|
-
description: "
|
|
5032
|
-
ref: "https://github.com/
|
|
5058
|
+
command: "touchUp",
|
|
5059
|
+
description: "Finger up on the screen.",
|
|
5060
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5033
5061
|
parameters: [
|
|
5034
5062
|
{
|
|
5035
5063
|
name: "x",
|
|
5036
5064
|
type: "number",
|
|
5037
|
-
description: "x
|
|
5065
|
+
description: "x coordinate on the screen",
|
|
5038
5066
|
required: true
|
|
5039
5067
|
},
|
|
5040
5068
|
{
|
|
5041
5069
|
name: "y",
|
|
5042
5070
|
type: "number",
|
|
5043
|
-
description: "y
|
|
5071
|
+
description: "y coordinate on the screen",
|
|
5072
|
+
required: true
|
|
5073
|
+
}
|
|
5074
|
+
],
|
|
5075
|
+
support: {
|
|
5076
|
+
android: {
|
|
5077
|
+
UiAutomator: "4.2+"
|
|
5078
|
+
}
|
|
5079
|
+
}
|
|
5080
|
+
}
|
|
5081
|
+
},
|
|
5082
|
+
"/session/:sessionId/touch/move": {
|
|
5083
|
+
POST: {
|
|
5084
|
+
command: "touchMove",
|
|
5085
|
+
description: "Finger move on the screen.",
|
|
5086
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5087
|
+
parameters: [
|
|
5088
|
+
{
|
|
5089
|
+
name: "x",
|
|
5090
|
+
type: "number",
|
|
5091
|
+
description: "x coordinate on the screen",
|
|
5044
5092
|
required: true
|
|
5045
5093
|
},
|
|
5046
5094
|
{
|
|
5047
|
-
name: "
|
|
5095
|
+
name: "y",
|
|
5048
5096
|
type: "number",
|
|
5049
|
-
description: "
|
|
5097
|
+
description: "y coordinate on the screen",
|
|
5050
5098
|
required: true
|
|
5051
5099
|
}
|
|
5052
|
-
]
|
|
5053
|
-
|
|
5054
|
-
|
|
5055
|
-
|
|
5056
|
-
|
|
5057
|
-
command: "freeze",
|
|
5058
|
-
description: "Freeze the current page. Extension for [Page Lifecycle API](https://developers.google.com/web/updates/2018/07/page-lifecycle-api).",
|
|
5059
|
-
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L625-L633",
|
|
5060
|
-
parameters: []
|
|
5061
|
-
}
|
|
5062
|
-
},
|
|
5063
|
-
"/session/:sessionId/goog/page/resume": {
|
|
5064
|
-
POST: {
|
|
5065
|
-
command: "resume",
|
|
5066
|
-
description: "Resume the current page. Extension for [Page Lifecycle API](https://developers.google.com/web/updates/2018/07/page-lifecycle-api).",
|
|
5067
|
-
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/window_commands.cc#L635-L645",
|
|
5068
|
-
parameters: []
|
|
5069
|
-
}
|
|
5070
|
-
},
|
|
5071
|
-
"/session/:sessionId/goog/cast/get_sinks": {
|
|
5072
|
-
GET: {
|
|
5073
|
-
command: "getCastSinks",
|
|
5074
|
-
description: "Returns the list of cast sinks (Cast devices) available to the Chrome media router.",
|
|
5075
|
-
ref: "https://chromium.googlesource.com/chromium/src/+/refs/tags/73.0.3683.121/chrome/test/chromedriver/server/http_handler.cc#748",
|
|
5076
|
-
parameters: [],
|
|
5077
|
-
returns: {
|
|
5078
|
-
type: "string[]",
|
|
5079
|
-
name: "sinks",
|
|
5080
|
-
description: "List of available sinks."
|
|
5100
|
+
],
|
|
5101
|
+
support: {
|
|
5102
|
+
android: {
|
|
5103
|
+
UiAutomator: "4.2+"
|
|
5104
|
+
}
|
|
5081
5105
|
}
|
|
5082
5106
|
}
|
|
5083
5107
|
},
|
|
5084
|
-
"/session/:sessionId/
|
|
5108
|
+
"/session/:sessionId/touch/longclick": {
|
|
5085
5109
|
POST: {
|
|
5086
|
-
command: "
|
|
5087
|
-
description: "
|
|
5088
|
-
ref: "https://
|
|
5110
|
+
command: "touchLongClick",
|
|
5111
|
+
description: "Long press on the touch screen using finger motion events.",
|
|
5112
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5089
5113
|
parameters: [
|
|
5090
5114
|
{
|
|
5091
|
-
name: "
|
|
5115
|
+
name: "element",
|
|
5092
5116
|
type: "string",
|
|
5093
|
-
description: "
|
|
5117
|
+
description: "ID of the element to long press on",
|
|
5094
5118
|
required: true
|
|
5095
5119
|
}
|
|
5096
|
-
]
|
|
5120
|
+
],
|
|
5121
|
+
support: {
|
|
5122
|
+
android: {
|
|
5123
|
+
UiAutomator: "4.2+"
|
|
5124
|
+
}
|
|
5125
|
+
}
|
|
5097
5126
|
}
|
|
5098
5127
|
},
|
|
5099
|
-
"/session/:sessionId/
|
|
5128
|
+
"/session/:sessionId/touch/flick": {
|
|
5100
5129
|
POST: {
|
|
5101
|
-
command: "
|
|
5102
|
-
description: "
|
|
5103
|
-
ref: "https://
|
|
5130
|
+
command: "touchFlick",
|
|
5131
|
+
description: "Flick on the touch screen using finger motion events. This flick command starts at a particular screen location.",
|
|
5132
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5104
5133
|
parameters: [
|
|
5105
5134
|
{
|
|
5106
|
-
name: "
|
|
5135
|
+
name: "xoffset",
|
|
5136
|
+
type: "number",
|
|
5137
|
+
description: "the x offset in pixels to flick by",
|
|
5138
|
+
required: false
|
|
5139
|
+
},
|
|
5140
|
+
{
|
|
5141
|
+
name: "yoffset",
|
|
5142
|
+
type: "number",
|
|
5143
|
+
description: "the y offset in pixels to flick by",
|
|
5144
|
+
required: false
|
|
5145
|
+
},
|
|
5146
|
+
{
|
|
5147
|
+
name: "element",
|
|
5107
5148
|
type: "string",
|
|
5108
|
-
description: "
|
|
5109
|
-
required:
|
|
5149
|
+
description: "ID of the element where the flick starts",
|
|
5150
|
+
required: false
|
|
5151
|
+
},
|
|
5152
|
+
{
|
|
5153
|
+
name: "speed",
|
|
5154
|
+
type: "number",
|
|
5155
|
+
description: "the speed in pixels per seconds",
|
|
5156
|
+
required: false
|
|
5157
|
+
},
|
|
5158
|
+
{
|
|
5159
|
+
name: "xspeed",
|
|
5160
|
+
type: "number",
|
|
5161
|
+
description: "the x speed in pixels per second",
|
|
5162
|
+
required: false
|
|
5163
|
+
},
|
|
5164
|
+
{
|
|
5165
|
+
name: "yspeed",
|
|
5166
|
+
type: "number",
|
|
5167
|
+
description: "the y speed in pixels per second",
|
|
5168
|
+
required: false
|
|
5110
5169
|
}
|
|
5111
|
-
]
|
|
5170
|
+
],
|
|
5171
|
+
support: {
|
|
5172
|
+
android: {
|
|
5173
|
+
UiAutomator: "4.2+"
|
|
5174
|
+
}
|
|
5175
|
+
}
|
|
5112
5176
|
}
|
|
5113
5177
|
},
|
|
5114
|
-
"/session/:sessionId/
|
|
5178
|
+
"/session/:sessionId/orientation": {
|
|
5115
5179
|
GET: {
|
|
5116
|
-
command: "
|
|
5117
|
-
description: "
|
|
5118
|
-
ref: "https://
|
|
5180
|
+
command: "getOrientation",
|
|
5181
|
+
description: "Get the current device orientation.",
|
|
5182
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5119
5183
|
parameters: [],
|
|
5120
5184
|
returns: {
|
|
5121
5185
|
type: "String",
|
|
5122
|
-
name: "
|
|
5123
|
-
description: "
|
|
5186
|
+
name: "orientation",
|
|
5187
|
+
description: "The current orientation corresponding to a value defined in ScreenOrientation: `LANDSCAPE|PORTRAIT`."
|
|
5188
|
+
},
|
|
5189
|
+
support: {
|
|
5190
|
+
android: {
|
|
5191
|
+
UiAutomator: "4.2+"
|
|
5192
|
+
},
|
|
5193
|
+
ios: {
|
|
5194
|
+
XCUITest: "9.3+"
|
|
5195
|
+
}
|
|
5124
5196
|
}
|
|
5125
|
-
}
|
|
5126
|
-
},
|
|
5127
|
-
"/session/:sessionId/goog/cast/stop_casting": {
|
|
5197
|
+
},
|
|
5128
5198
|
POST: {
|
|
5129
|
-
command: "
|
|
5130
|
-
description: "
|
|
5131
|
-
ref: "https://
|
|
5199
|
+
command: "setOrientation",
|
|
5200
|
+
description: "Set the device orientation",
|
|
5201
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5132
5202
|
parameters: [
|
|
5133
5203
|
{
|
|
5134
|
-
name: "
|
|
5204
|
+
name: "orientation",
|
|
5135
5205
|
type: "string",
|
|
5136
|
-
description: "
|
|
5206
|
+
description: "the new browser orientation as defined in ScreenOrientation: `LANDSCAPE|PORTRAIT`",
|
|
5137
5207
|
required: true
|
|
5138
5208
|
}
|
|
5139
|
-
]
|
|
5140
|
-
}
|
|
5141
|
-
},
|
|
5142
|
-
"/shutdown": {
|
|
5143
|
-
POST: {
|
|
5144
|
-
command: "shutdown",
|
|
5145
|
-
description: "Shutdown ChromeDriver process and consequently terminating all active sessions.",
|
|
5146
|
-
ref: "https://github.com/bayandin/chromedriver/blob/v2.45/session_commands.cc#L489-L498",
|
|
5147
|
-
parameters: []
|
|
5148
|
-
}
|
|
5149
|
-
},
|
|
5150
|
-
"/session/:sessionId/element/:elementId/screenshot": {
|
|
5151
|
-
GET: {
|
|
5152
|
-
command: "takeElementScreenshot",
|
|
5153
|
-
description: "The Take Element Screenshot command takes a screenshot of the visible region encompassed by the bounding rectangle of an element.",
|
|
5154
|
-
ref: "https://w3c.github.io/webdriver/#dfn-take-element-screenshot",
|
|
5155
|
-
variables: [
|
|
5156
|
-
{
|
|
5157
|
-
name: "elementId",
|
|
5158
|
-
description: "the id of an element returned in a previous call to Find Element(s)"
|
|
5159
|
-
}
|
|
5160
5209
|
],
|
|
5161
|
-
|
|
5162
|
-
{
|
|
5163
|
-
|
|
5164
|
-
|
|
5165
|
-
|
|
5166
|
-
|
|
5210
|
+
support: {
|
|
5211
|
+
android: {
|
|
5212
|
+
UiAutomator: "4.2+"
|
|
5213
|
+
},
|
|
5214
|
+
ios: {
|
|
5215
|
+
XCUITest: "9.3+"
|
|
5167
5216
|
}
|
|
5168
|
-
],
|
|
5169
|
-
returns: {
|
|
5170
|
-
type: "String",
|
|
5171
|
-
name: "screenshot",
|
|
5172
|
-
description: "The base64-encoded PNG image data comprising the screenshot of the visible region of an element\u2019s bounding rectangle after it has been scrolled into view."
|
|
5173
5217
|
}
|
|
5174
5218
|
}
|
|
5175
5219
|
},
|
|
5176
|
-
"/session/:sessionId/
|
|
5220
|
+
"/session/:sessionId/location": {
|
|
5177
5221
|
GET: {
|
|
5178
|
-
command: "
|
|
5179
|
-
description: "Get
|
|
5180
|
-
ref: "https://github.com/
|
|
5222
|
+
command: "getGeoLocation",
|
|
5223
|
+
description: "Get the current geo location.",
|
|
5224
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5181
5225
|
parameters: [],
|
|
5182
5226
|
returns: {
|
|
5183
|
-
type: "
|
|
5184
|
-
name: "
|
|
5185
|
-
description: "The
|
|
5227
|
+
type: "Object",
|
|
5228
|
+
name: "location",
|
|
5229
|
+
description: "The current geo location."
|
|
5186
5230
|
}
|
|
5187
|
-
}
|
|
5188
|
-
},
|
|
5189
|
-
"/session/:sessionId/se/log": {
|
|
5231
|
+
},
|
|
5190
5232
|
POST: {
|
|
5191
|
-
command: "
|
|
5192
|
-
description: "
|
|
5193
|
-
ref: "https://github.com/
|
|
5233
|
+
command: "setGeoLocation",
|
|
5234
|
+
description: "Set the current geo location.",
|
|
5235
|
+
ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
|
|
5194
5236
|
parameters: [
|
|
5195
5237
|
{
|
|
5196
|
-
name: "
|
|
5197
|
-
type: "
|
|
5198
|
-
description: "the
|
|
5238
|
+
name: "location",
|
|
5239
|
+
type: "object",
|
|
5240
|
+
description: "the new location (`{latitude: number, longitude: number, altitude: number}`)",
|
|
5199
5241
|
required: true
|
|
5200
5242
|
}
|
|
5201
|
-
]
|
|
5202
|
-
returns: {
|
|
5203
|
-
type: "Object[]",
|
|
5204
|
-
name: "logs",
|
|
5205
|
-
description: "The list of log entries."
|
|
5206
|
-
}
|
|
5243
|
+
]
|
|
5207
5244
|
}
|
|
5208
5245
|
}
|
|
5209
5246
|
};
|