@wdio/protocols 8.6.6 → 8.10.2
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 +57 -57
- package/build/index.d.ts +1 -1
- package/build/index.d.ts.map +1 -1
- package/build/protocols/appium.js +57 -57
- package/build/protocols/mjsonwp.js +1 -1
- package/package.json +2 -2
|
@@ -4,7 +4,7 @@ export default interface AppiumCommands {
|
|
|
4
4
|
* Appium Protocol Command
|
|
5
5
|
*
|
|
6
6
|
* Perform a shake action on the device.
|
|
7
|
-
* @ref
|
|
7
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/
|
|
8
8
|
*
|
|
9
9
|
*/
|
|
10
10
|
shake(): Promise<void>;
|
|
@@ -12,7 +12,7 @@ export default interface AppiumCommands {
|
|
|
12
12
|
* Appium Protocol Command
|
|
13
13
|
*
|
|
14
14
|
* Lock the device.
|
|
15
|
-
* @ref
|
|
15
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/
|
|
16
16
|
*
|
|
17
17
|
*/
|
|
18
18
|
lock(seconds?: number): Promise<void>;
|
|
@@ -20,7 +20,7 @@ export default interface AppiumCommands {
|
|
|
20
20
|
* Appium Protocol Command
|
|
21
21
|
*
|
|
22
22
|
* Unlock the device.
|
|
23
|
-
* @ref
|
|
23
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
unlock(): Promise<void>;
|
|
@@ -28,7 +28,7 @@ export default interface AppiumCommands {
|
|
|
28
28
|
* Appium Protocol Command
|
|
29
29
|
*
|
|
30
30
|
* Check whether the device is locked or not.
|
|
31
|
-
* @ref
|
|
31
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/
|
|
32
32
|
*
|
|
33
33
|
*/
|
|
34
34
|
isLocked(): Promise<boolean>;
|
|
@@ -36,7 +36,7 @@ export default interface AppiumCommands {
|
|
|
36
36
|
* Appium Protocol Command
|
|
37
37
|
*
|
|
38
38
|
* Start recording the screen.
|
|
39
|
-
* @ref
|
|
39
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/start-recording-screen/
|
|
40
40
|
*
|
|
41
41
|
*/
|
|
42
42
|
startRecordingScreen(options?: object): Promise<void>;
|
|
@@ -44,7 +44,7 @@ export default interface AppiumCommands {
|
|
|
44
44
|
* Appium Protocol Command
|
|
45
45
|
*
|
|
46
46
|
* Stop recording screen
|
|
47
|
-
* @ref
|
|
47
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/stop-recording-screen/
|
|
48
48
|
*
|
|
49
49
|
*/
|
|
50
50
|
stopRecordingScreen(remotePath?: string, username?: string, password?: string, method?: string): Promise<string>;
|
|
@@ -52,7 +52,7 @@ export default interface AppiumCommands {
|
|
|
52
52
|
* Appium Protocol Command
|
|
53
53
|
*
|
|
54
54
|
* Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery.
|
|
55
|
-
* @ref
|
|
55
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/
|
|
56
56
|
*
|
|
57
57
|
*/
|
|
58
58
|
getPerformanceDataTypes(): Promise<string[]>;
|
|
@@ -60,7 +60,7 @@ export default interface AppiumCommands {
|
|
|
60
60
|
* Appium Protocol Command
|
|
61
61
|
*
|
|
62
62
|
* Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery.
|
|
63
|
-
* @ref
|
|
63
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/
|
|
64
64
|
*
|
|
65
65
|
*/
|
|
66
66
|
getPerformanceData(packageName: string, dataType: string, dataReadTimeout?: number): Promise<string[]>;
|
|
@@ -68,7 +68,7 @@ export default interface AppiumCommands {
|
|
|
68
68
|
* Appium Protocol Command
|
|
69
69
|
*
|
|
70
70
|
* Press a particular key on the device.
|
|
71
|
-
* @ref
|
|
71
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/
|
|
72
72
|
*
|
|
73
73
|
*/
|
|
74
74
|
pressKeyCode(keycode: number, metastate?: number, flags?: number): Promise<void>;
|
|
@@ -76,7 +76,7 @@ export default interface AppiumCommands {
|
|
|
76
76
|
* Appium Protocol Command
|
|
77
77
|
*
|
|
78
78
|
* Press and hold a particular key code on the device.
|
|
79
|
-
* @ref
|
|
79
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/
|
|
80
80
|
*
|
|
81
81
|
*/
|
|
82
82
|
longPressKeyCode(keycode: number, metastate?: number, flags?: number): Promise<void>;
|
|
@@ -92,7 +92,7 @@ export default interface AppiumCommands {
|
|
|
92
92
|
* Appium Protocol Command
|
|
93
93
|
*
|
|
94
94
|
* Rotate the device in three dimensions.
|
|
95
|
-
* @ref
|
|
95
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/rotate/
|
|
96
96
|
*
|
|
97
97
|
*/
|
|
98
98
|
rotateDevice(x: number, y: number, radius: number, rotation: number, touchCount: number, duration: number, element?: string): Promise<void>;
|
|
@@ -100,7 +100,7 @@ export default interface AppiumCommands {
|
|
|
100
100
|
* Appium Protocol Command
|
|
101
101
|
*
|
|
102
102
|
* Get the name of the current Android activity.
|
|
103
|
-
* @ref
|
|
103
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/
|
|
104
104
|
*
|
|
105
105
|
*/
|
|
106
106
|
getCurrentActivity(): Promise<string>;
|
|
@@ -108,7 +108,7 @@ export default interface AppiumCommands {
|
|
|
108
108
|
* Appium Protocol Command
|
|
109
109
|
*
|
|
110
110
|
* Get the name of the current Android package.
|
|
111
|
-
* @ref
|
|
111
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/
|
|
112
112
|
*
|
|
113
113
|
*/
|
|
114
114
|
getCurrentPackage(): Promise<string>;
|
|
@@ -116,7 +116,7 @@ export default interface AppiumCommands {
|
|
|
116
116
|
* Appium Protocol Command
|
|
117
117
|
*
|
|
118
118
|
* Install the given app onto the device.
|
|
119
|
-
* @ref
|
|
119
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/install-app/
|
|
120
120
|
*
|
|
121
121
|
*/
|
|
122
122
|
installApp(appPath: string): Promise<void>;
|
|
@@ -124,7 +124,7 @@ export default interface AppiumCommands {
|
|
|
124
124
|
* Appium Protocol Command
|
|
125
125
|
*
|
|
126
126
|
* Activate the given app onto the device
|
|
127
|
-
* @ref
|
|
127
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/activate-app/
|
|
128
128
|
*
|
|
129
129
|
*/
|
|
130
130
|
activateApp(appId: string): Promise<void>;
|
|
@@ -132,7 +132,7 @@ export default interface AppiumCommands {
|
|
|
132
132
|
* Appium Protocol Command
|
|
133
133
|
*
|
|
134
134
|
* Remove an app from the device.
|
|
135
|
-
* @ref
|
|
135
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/remove-app/
|
|
136
136
|
*
|
|
137
137
|
*/
|
|
138
138
|
removeApp(appId: string): Promise<void>;
|
|
@@ -140,7 +140,7 @@ export default interface AppiumCommands {
|
|
|
140
140
|
* Appium Protocol Command
|
|
141
141
|
*
|
|
142
142
|
* Terminate the given app on the device
|
|
143
|
-
* @ref
|
|
143
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/terminate-app/
|
|
144
144
|
*
|
|
145
145
|
*/
|
|
146
146
|
terminateApp(appId: string): Promise<void>;
|
|
@@ -148,7 +148,7 @@ export default interface AppiumCommands {
|
|
|
148
148
|
* Appium Protocol Command
|
|
149
149
|
*
|
|
150
150
|
* Check whether the specified app is installed on the device.
|
|
151
|
-
* @ref
|
|
151
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/is-app-installed/
|
|
152
152
|
*
|
|
153
153
|
*/
|
|
154
154
|
isAppInstalled(appId: string): Promise<boolean>;
|
|
@@ -156,7 +156,7 @@ export default interface AppiumCommands {
|
|
|
156
156
|
* Appium Protocol Command
|
|
157
157
|
*
|
|
158
158
|
* Get the given app status on the device
|
|
159
|
-
* @ref
|
|
159
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/app-state/
|
|
160
160
|
*
|
|
161
161
|
*/
|
|
162
162
|
queryAppState(appId: string): Promise<number>;
|
|
@@ -164,7 +164,7 @@ export default interface AppiumCommands {
|
|
|
164
164
|
* Appium Protocol Command
|
|
165
165
|
*
|
|
166
166
|
* Hide soft keyboard.
|
|
167
|
-
* @ref
|
|
167
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/keys/hide-keyboard/
|
|
168
168
|
*
|
|
169
169
|
*/
|
|
170
170
|
hideKeyboard(strategy?: string, key?: string, keyCode?: string, keyName?: string): Promise<void>;
|
|
@@ -172,7 +172,7 @@ export default interface AppiumCommands {
|
|
|
172
172
|
* Appium Protocol Command
|
|
173
173
|
*
|
|
174
174
|
* Whether or not the soft keyboard is shown.
|
|
175
|
-
* @ref
|
|
175
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/keys/is-keyboard-shown/
|
|
176
176
|
*
|
|
177
177
|
*/
|
|
178
178
|
isKeyboardShown(): Promise<boolean>;
|
|
@@ -180,7 +180,7 @@ export default interface AppiumCommands {
|
|
|
180
180
|
* Appium Protocol Command
|
|
181
181
|
*
|
|
182
182
|
* Place a file onto the device in a particular place.
|
|
183
|
-
* @ref
|
|
183
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/files/push-file/
|
|
184
184
|
*
|
|
185
185
|
*/
|
|
186
186
|
pushFile(path: string, data: string): Promise<void>;
|
|
@@ -188,7 +188,7 @@ export default interface AppiumCommands {
|
|
|
188
188
|
* Appium Protocol Command
|
|
189
189
|
*
|
|
190
190
|
* Retrieve a file from the device's file system.
|
|
191
|
-
* @ref
|
|
191
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/files/pull-file/
|
|
192
192
|
*
|
|
193
193
|
*/
|
|
194
194
|
pullFile(path: string): Promise<string>;
|
|
@@ -196,7 +196,7 @@ export default interface AppiumCommands {
|
|
|
196
196
|
* Appium Protocol Command
|
|
197
197
|
*
|
|
198
198
|
* Retrieve a folder from the device's file system.
|
|
199
|
-
* @ref
|
|
199
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/files/pull-folder/
|
|
200
200
|
*
|
|
201
201
|
*/
|
|
202
202
|
pullFolder(path: string): Promise<void>;
|
|
@@ -204,7 +204,7 @@ export default interface AppiumCommands {
|
|
|
204
204
|
* Appium Protocol Command
|
|
205
205
|
*
|
|
206
206
|
* Toggle airplane mode on device.
|
|
207
|
-
* @ref
|
|
207
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/
|
|
208
208
|
*
|
|
209
209
|
*/
|
|
210
210
|
toggleAirplaneMode(): Promise<void>;
|
|
@@ -212,7 +212,7 @@ export default interface AppiumCommands {
|
|
|
212
212
|
* Appium Protocol Command
|
|
213
213
|
*
|
|
214
214
|
* Switch the state of data service.
|
|
215
|
-
* @ref
|
|
215
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/
|
|
216
216
|
*
|
|
217
217
|
*/
|
|
218
218
|
toggleData(): Promise<void>;
|
|
@@ -220,7 +220,7 @@ export default interface AppiumCommands {
|
|
|
220
220
|
* Appium Protocol Command
|
|
221
221
|
*
|
|
222
222
|
* Switch the state of the wifi service.
|
|
223
|
-
* @ref
|
|
223
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/
|
|
224
224
|
*
|
|
225
225
|
*/
|
|
226
226
|
toggleWiFi(): Promise<void>;
|
|
@@ -228,7 +228,7 @@ export default interface AppiumCommands {
|
|
|
228
228
|
* Appium Protocol Command
|
|
229
229
|
*
|
|
230
230
|
* Switch the state of the location service.
|
|
231
|
-
* @ref
|
|
231
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/
|
|
232
232
|
*
|
|
233
233
|
*/
|
|
234
234
|
toggleLocationServices(): Promise<void>;
|
|
@@ -236,7 +236,7 @@ export default interface AppiumCommands {
|
|
|
236
236
|
* Appium Protocol Command
|
|
237
237
|
*
|
|
238
238
|
* Set network speed (Emulator only)
|
|
239
|
-
* @ref
|
|
239
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/
|
|
240
240
|
*
|
|
241
241
|
*/
|
|
242
242
|
toggleNetworkSpeed(netspeed: string): Promise<void>;
|
|
@@ -244,7 +244,7 @@ export default interface AppiumCommands {
|
|
|
244
244
|
* Appium Protocol Command
|
|
245
245
|
*
|
|
246
246
|
* Open Android notifications (Emulator only).
|
|
247
|
-
* @ref
|
|
247
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/
|
|
248
248
|
*
|
|
249
249
|
*/
|
|
250
250
|
openNotifications(): Promise<void>;
|
|
@@ -252,7 +252,7 @@ export default interface AppiumCommands {
|
|
|
252
252
|
* Appium Protocol Command
|
|
253
253
|
*
|
|
254
254
|
* Start an Android activity by providing package name and activity name.
|
|
255
|
-
* @ref
|
|
255
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/
|
|
256
256
|
*
|
|
257
257
|
*/
|
|
258
258
|
startActivity(appPackage: string, appActivity: string, appWaitPackage?: string, appWaitActivity?: string, intentAction?: string, intentCategory?: string, intentFlags?: string, optionalIntentArguments?: string, dontStopAppOnReset?: string): Promise<void>;
|
|
@@ -260,7 +260,7 @@ export default interface AppiumCommands {
|
|
|
260
260
|
* Appium Protocol Command
|
|
261
261
|
*
|
|
262
262
|
* Retrieve visibility and bounds information of the status and navigation bars.
|
|
263
|
-
* @ref
|
|
263
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/
|
|
264
264
|
*
|
|
265
265
|
*/
|
|
266
266
|
getSystemBars(): Promise<object[]>;
|
|
@@ -268,7 +268,7 @@ export default interface AppiumCommands {
|
|
|
268
268
|
* Appium Protocol Command
|
|
269
269
|
*
|
|
270
270
|
* Get the time on the device.
|
|
271
|
-
* @ref
|
|
271
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/system/system-time/
|
|
272
272
|
*
|
|
273
273
|
*/
|
|
274
274
|
getDeviceTime(): Promise<string>;
|
|
@@ -283,8 +283,8 @@ export default interface AppiumCommands {
|
|
|
283
283
|
/**
|
|
284
284
|
* Appium Protocol Command
|
|
285
285
|
*
|
|
286
|
-
* 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](
|
|
287
|
-
* @ref
|
|
286
|
+
* 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.
|
|
287
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/
|
|
288
288
|
*
|
|
289
289
|
*/
|
|
290
290
|
touchId(match: boolean): Promise<void>;
|
|
@@ -292,15 +292,15 @@ export default interface AppiumCommands {
|
|
|
292
292
|
* Appium Protocol Command
|
|
293
293
|
*
|
|
294
294
|
* 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.
|
|
295
|
-
* @ref
|
|
295
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/
|
|
296
296
|
*
|
|
297
297
|
*/
|
|
298
298
|
toggleEnrollTouchId(enabled?: boolean): Promise<void>;
|
|
299
299
|
/**
|
|
300
300
|
* Appium Protocol Command
|
|
301
301
|
*
|
|
302
|
-
* Launch an app on device. iOS tests with XCUITest can also use the `mobile: launchApp` method. See detailed [documentation](
|
|
303
|
-
* @ref
|
|
302
|
+
* Launch an app on device. iOS tests with XCUITest can also use the `mobile: launchApp` method. See detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-launchapp).
|
|
303
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/
|
|
304
304
|
*
|
|
305
305
|
*/
|
|
306
306
|
launchApp(): Promise<void>;
|
|
@@ -308,15 +308,15 @@ export default interface AppiumCommands {
|
|
|
308
308
|
* Appium Protocol Command
|
|
309
309
|
*
|
|
310
310
|
* Close an app on device.
|
|
311
|
-
* @ref
|
|
311
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/
|
|
312
312
|
*
|
|
313
313
|
*/
|
|
314
314
|
closeApp(): Promise<void>;
|
|
315
315
|
/**
|
|
316
316
|
* Appium Protocol Command
|
|
317
317
|
*
|
|
318
|
-
* Send the currently running app for this session to the background. iOS tests with XCUITest can also use the `mobile: terminateApp` method to terminate the current app (see detailed [documentation](
|
|
319
|
-
* @ref
|
|
318
|
+
* Send the currently running app for this session to the background. iOS tests with XCUITest can also use the `mobile: terminateApp` method to terminate the current app (see detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-terminateapp)), and the `mobile: activateApp` to activate an existing application on the device under test and moves it to the foreground (see detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-activateapp)).
|
|
319
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/
|
|
320
320
|
*
|
|
321
321
|
*/
|
|
322
322
|
background(seconds: (number | null)): Promise<void>;
|
|
@@ -324,7 +324,7 @@ export default interface AppiumCommands {
|
|
|
324
324
|
* Appium Protocol Command
|
|
325
325
|
*
|
|
326
326
|
* Get test coverage data.
|
|
327
|
-
* @ref
|
|
327
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/end-test-coverage/
|
|
328
328
|
*
|
|
329
329
|
*/
|
|
330
330
|
endCoverage(intent: string, path: string): Promise<void>;
|
|
@@ -332,7 +332,7 @@ export default interface AppiumCommands {
|
|
|
332
332
|
* Appium Protocol Command
|
|
333
333
|
*
|
|
334
334
|
* Get app strings.
|
|
335
|
-
* @ref
|
|
335
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/
|
|
336
336
|
*
|
|
337
337
|
*/
|
|
338
338
|
getStrings(language?: string, stringFile?: string): Promise<StringsReturn>;
|
|
@@ -356,7 +356,7 @@ export default interface AppiumCommands {
|
|
|
356
356
|
* Appium Protocol Command
|
|
357
357
|
*
|
|
358
358
|
* Retrieve the current settings on the device.
|
|
359
|
-
* @ref
|
|
359
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/session/settings/get-settings/
|
|
360
360
|
*
|
|
361
361
|
*/
|
|
362
362
|
getSettings(): Promise<SettingsReturn>;
|
|
@@ -364,7 +364,7 @@ export default interface AppiumCommands {
|
|
|
364
364
|
* Appium Protocol Command
|
|
365
365
|
*
|
|
366
366
|
* Update the current setting on the device.
|
|
367
|
-
* @ref
|
|
367
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/session/settings/update-settings/
|
|
368
368
|
*
|
|
369
369
|
*/
|
|
370
370
|
updateSettings(settings: object): Promise<void>;
|
|
@@ -380,7 +380,7 @@ export default interface AppiumCommands {
|
|
|
380
380
|
* Appium Protocol Command
|
|
381
381
|
*
|
|
382
382
|
* Make GSM call (Emulator only).
|
|
383
|
-
* @ref
|
|
383
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/
|
|
384
384
|
*
|
|
385
385
|
*/
|
|
386
386
|
gsmCall(phoneNumber: string, action: string): Promise<void>;
|
|
@@ -388,7 +388,7 @@ export default interface AppiumCommands {
|
|
|
388
388
|
* Appium Protocol Command
|
|
389
389
|
*
|
|
390
390
|
* Set GSM signal strength (Emulator only).
|
|
391
|
-
* @ref
|
|
391
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/
|
|
392
392
|
*
|
|
393
393
|
*/
|
|
394
394
|
gsmSignal(signalStrength: string, signalStrengh?: string): Promise<void>;
|
|
@@ -396,7 +396,7 @@ export default interface AppiumCommands {
|
|
|
396
396
|
* Appium Protocol Command
|
|
397
397
|
*
|
|
398
398
|
* Set the battery percentage (Emulator only).
|
|
399
|
-
* @ref
|
|
399
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/
|
|
400
400
|
*
|
|
401
401
|
*/
|
|
402
402
|
powerCapacity(percent: number): Promise<void>;
|
|
@@ -404,7 +404,7 @@ export default interface AppiumCommands {
|
|
|
404
404
|
* Appium Protocol Command
|
|
405
405
|
*
|
|
406
406
|
* Set the state of the battery charger to connected or not (Emulator only).
|
|
407
|
-
* @ref
|
|
407
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/
|
|
408
408
|
*
|
|
409
409
|
*/
|
|
410
410
|
powerAC(state: string): Promise<void>;
|
|
@@ -412,7 +412,7 @@ export default interface AppiumCommands {
|
|
|
412
412
|
* Appium Protocol Command
|
|
413
413
|
*
|
|
414
414
|
* Set GSM voice state (Emulator only).
|
|
415
|
-
* @ref
|
|
415
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/
|
|
416
416
|
*
|
|
417
417
|
*/
|
|
418
418
|
gsmVoice(state: string): Promise<void>;
|
|
@@ -420,7 +420,7 @@ export default interface AppiumCommands {
|
|
|
420
420
|
* Appium Protocol Command
|
|
421
421
|
*
|
|
422
422
|
* Simulate an SMS message (Emulator only).
|
|
423
|
-
* @ref
|
|
423
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/
|
|
424
424
|
*
|
|
425
425
|
*/
|
|
426
426
|
sendSms(phoneNumber: string, message: string): Promise<void>;
|
|
@@ -428,7 +428,7 @@ export default interface AppiumCommands {
|
|
|
428
428
|
* Appium Protocol Command
|
|
429
429
|
*
|
|
430
430
|
* Authenticate users by using their finger print scans on supported emulators.
|
|
431
|
-
* @ref
|
|
431
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/
|
|
432
432
|
*
|
|
433
433
|
*/
|
|
434
434
|
fingerPrint(fingerprintId: number): Promise<void>;
|
|
@@ -436,7 +436,7 @@ export default interface AppiumCommands {
|
|
|
436
436
|
* Appium Protocol Command
|
|
437
437
|
*
|
|
438
438
|
* Set the content of the system clipboard
|
|
439
|
-
* @ref
|
|
439
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/
|
|
440
440
|
*
|
|
441
441
|
*/
|
|
442
442
|
setClipboard(content: string, contentType?: string, label?: string): Promise<string>;
|
|
@@ -444,7 +444,7 @@ export default interface AppiumCommands {
|
|
|
444
444
|
* Appium Protocol Command
|
|
445
445
|
*
|
|
446
446
|
* Get the content of the system clipboard
|
|
447
|
-
* @ref
|
|
447
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/
|
|
448
448
|
*
|
|
449
449
|
*/
|
|
450
450
|
getClipboard(contentType?: string): Promise<string>;
|
|
@@ -452,7 +452,7 @@ export default interface AppiumCommands {
|
|
|
452
452
|
* Appium Protocol Command
|
|
453
453
|
*
|
|
454
454
|
* 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.
|
|
455
|
-
* @ref
|
|
455
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/interactions/touch/touch-perform/
|
|
456
456
|
*
|
|
457
457
|
* @example
|
|
458
458
|
* ```js
|
|
@@ -498,7 +498,7 @@ export default interface AppiumCommands {
|
|
|
498
498
|
* Appium Protocol Command
|
|
499
499
|
*
|
|
500
500
|
* This functionality is only available from within a native context. Perform a multi touch action sequence.
|
|
501
|
-
* @ref
|
|
501
|
+
* @ref https://appium.github.io/appium.io/docs/en/commands/interactions/touch/multi-touch-perform/
|
|
502
502
|
*
|
|
503
503
|
*/
|
|
504
504
|
multiTouchPerform(actions: object[]): Promise<void>;
|
|
@@ -530,7 +530,7 @@ export default interface AppiumCommands {
|
|
|
530
530
|
* Appium Protocol Command
|
|
531
531
|
*
|
|
532
532
|
* Performs images comparison using OpenCV framework features. It is expected that both OpenCV framework and opencv4nodejs module are installed on the machine where Appium server is running.
|
|
533
|
-
* @ref
|
|
533
|
+
* @ref https://appium.github.io/appium.io/docs/en/writing-running-appium/image-comparison/
|
|
534
534
|
*
|
|
535
535
|
*/
|
|
536
536
|
compareImages(mode: string, firstImage: string, secondImage: string, options: object): Promise<ProtocolCommandResponse>;
|
package/build/index.d.ts
CHANGED
|
@@ -16,7 +16,7 @@ import ChromiumProtocol from './protocols/chromium.js';
|
|
|
16
16
|
import GeckoProtocol from './protocols/gecko.js';
|
|
17
17
|
import SauceLabsProtocol from './protocols/saucelabs.js';
|
|
18
18
|
import SeleniumProtocol from './protocols/selenium.js';
|
|
19
|
-
export interface ProtocolCommands extends WebDriverCommands, Omit<JSONWPCommands, keyof WebDriverCommands>, AppiumCommands, ChromiumCommands, Omit<MJSONWPCommands, keyof AppiumCommands | keyof ChromiumCommands>, SauceLabsCommands, SeleniumCommands, WebDriverBidiCommands {
|
|
19
|
+
export interface ProtocolCommands extends WebDriverCommands, Omit<JSONWPCommands, keyof WebDriverCommands>, AppiumCommands, ChromiumCommands, Omit<MJSONWPCommands, keyof AppiumCommands | keyof ChromiumCommands>, SauceLabsCommands, SeleniumCommands, GeckoCommands, WebDriverBidiCommands {
|
|
20
20
|
}
|
|
21
21
|
export * from './types.js';
|
|
22
22
|
export { WebDriverProtocol, MJsonWProtocol, JsonWProtocol, AppiumProtocol, ChromiumProtocol, SauceLabsProtocol, SeleniumProtocol, GeckoProtocol, WebDriverBidiProtocol, AppiumCommands, ChromiumCommands, JSONWPCommands, MJSONWPCommands, SauceLabsCommands, SeleniumCommands, WebDriverCommands, GeckoCommands, WebDriverBidiCommands };
|
package/build/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,cAAc,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,gBAAgB,MAAM,wBAAwB,CAAA;AAC1D,OAAO,KAAK,aAAa,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,cAAc,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,eAAe,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,iBAAiB,MAAM,yBAAyB,CAAA;AAC5D,OAAO,KAAK,gBAAgB,MAAM,wBAAwB,CAAA;AAC1D,OAAO,KAAK,iBAAiB,MAAM,yBAAyB,CAAA;AAC5D,OAAO,KAAK,qBAAqB,MAAM,6BAA6B,CAAA;AAEpE,OAAO,iBAAiB,MAAM,0BAA0B,CAAA;AACxD,OAAO,qBAAqB,MAAM,8BAA8B,CAAA;AAChE,OAAO,cAAc,MAAM,wBAAwB,CAAA;AACnD,OAAO,aAAa,MAAM,uBAAuB,CAAA;AACjD,OAAO,cAAc,MAAM,uBAAuB,CAAA;AAClD,OAAO,gBAAgB,MAAM,yBAAyB,CAAA;AACtD,OAAO,aAAa,MAAM,sBAAsB,CAAA;AAChD,OAAO,iBAAiB,MAAM,0BAA0B,CAAA;AACxD,OAAO,gBAAgB,MAAM,yBAAyB,CAAA;AAEtD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,iBAAiB,CAAC,EAAE,cAAc,EAAE,gBAAgB,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,cAAc,GAAG,MAAM,gBAAgB,CAAC,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,qBAAqB;CAAG;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,cAAc,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,gBAAgB,MAAM,wBAAwB,CAAA;AAC1D,OAAO,KAAK,aAAa,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,cAAc,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,eAAe,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,iBAAiB,MAAM,yBAAyB,CAAA;AAC5D,OAAO,KAAK,gBAAgB,MAAM,wBAAwB,CAAA;AAC1D,OAAO,KAAK,iBAAiB,MAAM,yBAAyB,CAAA;AAC5D,OAAO,KAAK,qBAAqB,MAAM,6BAA6B,CAAA;AAEpE,OAAO,iBAAiB,MAAM,0BAA0B,CAAA;AACxD,OAAO,qBAAqB,MAAM,8BAA8B,CAAA;AAChE,OAAO,cAAc,MAAM,wBAAwB,CAAA;AACnD,OAAO,aAAa,MAAM,uBAAuB,CAAA;AACjD,OAAO,cAAc,MAAM,uBAAuB,CAAA;AAClD,OAAO,gBAAgB,MAAM,yBAAyB,CAAA;AACtD,OAAO,aAAa,MAAM,sBAAsB,CAAA;AAChD,OAAO,iBAAiB,MAAM,0BAA0B,CAAA;AACxD,OAAO,gBAAgB,MAAM,yBAAyB,CAAA;AAEtD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,iBAAiB,CAAC,EAAE,cAAc,EAAE,gBAAgB,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,cAAc,GAAG,MAAM,gBAAgB,CAAC,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,aAAa,EAAE,qBAAqB;CAAG;AAEhS,cAAc,YAAY,CAAA;AAC1B,OAAO,EAEH,iBAAiB,EAAE,cAAc,EAAE,aAAa,EAAE,cAAc,EAChE,gBAAgB,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,aAAa,EACpE,qBAAqB,EAErB,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,eAAe,EACjE,iBAAiB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,aAAa,EACrE,qBAAqB,EACxB,CAAA;AAED,eAAO,MAAM,eAAe,UAI3B,CAAA"}
|
|
@@ -3,7 +3,7 @@ export default {
|
|
|
3
3
|
POST: {
|
|
4
4
|
command: 'shake',
|
|
5
5
|
description: 'Perform a shake action on the device.',
|
|
6
|
-
ref: '
|
|
6
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/',
|
|
7
7
|
parameters: [],
|
|
8
8
|
support: {
|
|
9
9
|
ios: {
|
|
@@ -17,7 +17,7 @@ export default {
|
|
|
17
17
|
POST: {
|
|
18
18
|
command: 'lock',
|
|
19
19
|
description: 'Lock the device.',
|
|
20
|
-
ref: '
|
|
20
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/',
|
|
21
21
|
parameters: [
|
|
22
22
|
{
|
|
23
23
|
name: 'seconds',
|
|
@@ -43,7 +43,7 @@ export default {
|
|
|
43
43
|
POST: {
|
|
44
44
|
command: 'unlock',
|
|
45
45
|
description: 'Unlock the device.',
|
|
46
|
-
ref: '
|
|
46
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/',
|
|
47
47
|
parameters: [],
|
|
48
48
|
support: {
|
|
49
49
|
android: {
|
|
@@ -59,7 +59,7 @@ export default {
|
|
|
59
59
|
POST: {
|
|
60
60
|
command: 'isLocked',
|
|
61
61
|
description: 'Check whether the device is locked or not.',
|
|
62
|
-
ref: '
|
|
62
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/',
|
|
63
63
|
parameters: [],
|
|
64
64
|
returns: {
|
|
65
65
|
type: 'boolean',
|
|
@@ -80,7 +80,7 @@ export default {
|
|
|
80
80
|
POST: {
|
|
81
81
|
command: 'startRecordingScreen',
|
|
82
82
|
description: 'Start recording the screen.',
|
|
83
|
-
ref: '
|
|
83
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/start-recording-screen/',
|
|
84
84
|
parameters: [
|
|
85
85
|
{
|
|
86
86
|
name: 'options',
|
|
@@ -103,7 +103,7 @@ export default {
|
|
|
103
103
|
POST: {
|
|
104
104
|
command: 'stopRecordingScreen',
|
|
105
105
|
description: 'Stop recording screen',
|
|
106
|
-
ref: '
|
|
106
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/stop-recording-screen/',
|
|
107
107
|
parameters: [
|
|
108
108
|
{
|
|
109
109
|
name: 'remotePath',
|
|
@@ -149,7 +149,7 @@ export default {
|
|
|
149
149
|
POST: {
|
|
150
150
|
command: 'getPerformanceDataTypes',
|
|
151
151
|
description: 'Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery.',
|
|
152
|
-
ref: '
|
|
152
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/',
|
|
153
153
|
parameters: [],
|
|
154
154
|
returns: {
|
|
155
155
|
type: 'string[]',
|
|
@@ -167,7 +167,7 @@ export default {
|
|
|
167
167
|
POST: {
|
|
168
168
|
command: 'getPerformanceData',
|
|
169
169
|
description: 'Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery.',
|
|
170
|
-
ref: '
|
|
170
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/',
|
|
171
171
|
parameters: [
|
|
172
172
|
{
|
|
173
173
|
name: 'packageName',
|
|
@@ -204,7 +204,7 @@ export default {
|
|
|
204
204
|
POST: {
|
|
205
205
|
command: 'pressKeyCode',
|
|
206
206
|
description: 'Press a particular key on the device.',
|
|
207
|
-
ref: '
|
|
207
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/',
|
|
208
208
|
parameters: [
|
|
209
209
|
{
|
|
210
210
|
name: 'keycode',
|
|
@@ -236,7 +236,7 @@ export default {
|
|
|
236
236
|
POST: {
|
|
237
237
|
command: 'longPressKeyCode',
|
|
238
238
|
description: 'Press and hold a particular key code on the device.',
|
|
239
|
-
ref: '
|
|
239
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/',
|
|
240
240
|
parameters: [
|
|
241
241
|
{
|
|
242
242
|
name: 'keycode',
|
|
@@ -290,7 +290,7 @@ export default {
|
|
|
290
290
|
POST: {
|
|
291
291
|
command: 'rotateDevice',
|
|
292
292
|
description: 'Rotate the device in three dimensions.',
|
|
293
|
-
ref: '
|
|
293
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/interactions/rotate/',
|
|
294
294
|
parameters: [
|
|
295
295
|
{
|
|
296
296
|
name: 'x',
|
|
@@ -352,7 +352,7 @@ export default {
|
|
|
352
352
|
GET: {
|
|
353
353
|
command: 'getCurrentActivity',
|
|
354
354
|
description: 'Get the name of the current Android activity.',
|
|
355
|
-
ref: '
|
|
355
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/',
|
|
356
356
|
parameters: [],
|
|
357
357
|
returns: {
|
|
358
358
|
type: 'string',
|
|
@@ -370,7 +370,7 @@ export default {
|
|
|
370
370
|
GET: {
|
|
371
371
|
command: 'getCurrentPackage',
|
|
372
372
|
description: 'Get the name of the current Android package.',
|
|
373
|
-
ref: '
|
|
373
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/',
|
|
374
374
|
parameters: [],
|
|
375
375
|
returns: {
|
|
376
376
|
type: 'string',
|
|
@@ -388,7 +388,7 @@ export default {
|
|
|
388
388
|
POST: {
|
|
389
389
|
command: 'installApp',
|
|
390
390
|
description: 'Install the given app onto the device.',
|
|
391
|
-
ref: '
|
|
391
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/install-app/',
|
|
392
392
|
parameters: [
|
|
393
393
|
{
|
|
394
394
|
name: 'appPath',
|
|
@@ -412,7 +412,7 @@ export default {
|
|
|
412
412
|
POST: {
|
|
413
413
|
command: 'activateApp',
|
|
414
414
|
description: 'Activate the given app onto the device',
|
|
415
|
-
ref: '
|
|
415
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/activate-app/',
|
|
416
416
|
parameters: [
|
|
417
417
|
{
|
|
418
418
|
name: 'appId',
|
|
@@ -435,7 +435,7 @@ export default {
|
|
|
435
435
|
POST: {
|
|
436
436
|
command: 'removeApp',
|
|
437
437
|
description: 'Remove an app from the device.',
|
|
438
|
-
ref: '
|
|
438
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/remove-app/',
|
|
439
439
|
parameters: [
|
|
440
440
|
{
|
|
441
441
|
name: 'appId',
|
|
@@ -459,7 +459,7 @@ export default {
|
|
|
459
459
|
POST: {
|
|
460
460
|
command: 'terminateApp',
|
|
461
461
|
description: 'Terminate the given app on the device',
|
|
462
|
-
ref: '
|
|
462
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/terminate-app/',
|
|
463
463
|
parameters: [
|
|
464
464
|
{
|
|
465
465
|
name: 'appId',
|
|
@@ -482,7 +482,7 @@ export default {
|
|
|
482
482
|
POST: {
|
|
483
483
|
command: 'isAppInstalled',
|
|
484
484
|
description: 'Check whether the specified app is installed on the device.',
|
|
485
|
-
ref: '
|
|
485
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/is-app-installed/',
|
|
486
486
|
parameters: [
|
|
487
487
|
{
|
|
488
488
|
name: 'appId',
|
|
@@ -511,7 +511,7 @@ export default {
|
|
|
511
511
|
POST: {
|
|
512
512
|
command: 'queryAppState',
|
|
513
513
|
description: 'Get the given app status on the device',
|
|
514
|
-
ref: '
|
|
514
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/app-state/',
|
|
515
515
|
parameters: [
|
|
516
516
|
{
|
|
517
517
|
name: 'appId',
|
|
@@ -539,7 +539,7 @@ export default {
|
|
|
539
539
|
POST: {
|
|
540
540
|
command: 'hideKeyboard',
|
|
541
541
|
description: 'Hide soft keyboard.',
|
|
542
|
-
ref: '
|
|
542
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/keys/hide-keyboard/',
|
|
543
543
|
parameters: [
|
|
544
544
|
{
|
|
545
545
|
name: 'strategy',
|
|
@@ -584,7 +584,7 @@ export default {
|
|
|
584
584
|
GET: {
|
|
585
585
|
command: 'isKeyboardShown',
|
|
586
586
|
description: 'Whether or not the soft keyboard is shown.',
|
|
587
|
-
ref: '
|
|
587
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/keys/is-keyboard-shown/',
|
|
588
588
|
parameters: [],
|
|
589
589
|
returns: {
|
|
590
590
|
type: 'boolean',
|
|
@@ -609,7 +609,7 @@ export default {
|
|
|
609
609
|
POST: {
|
|
610
610
|
command: 'pushFile',
|
|
611
611
|
description: 'Place a file onto the device in a particular place.',
|
|
612
|
-
ref: '
|
|
612
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/files/push-file/',
|
|
613
613
|
parameters: [
|
|
614
614
|
{
|
|
615
615
|
name: 'path',
|
|
@@ -639,7 +639,7 @@ export default {
|
|
|
639
639
|
POST: {
|
|
640
640
|
command: 'pullFile',
|
|
641
641
|
description: "Retrieve a file from the device's file system.",
|
|
642
|
-
ref: '
|
|
642
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/files/pull-file/',
|
|
643
643
|
parameters: [
|
|
644
644
|
{
|
|
645
645
|
name: 'path',
|
|
@@ -668,7 +668,7 @@ export default {
|
|
|
668
668
|
POST: {
|
|
669
669
|
command: 'pullFolder',
|
|
670
670
|
description: "Retrieve a folder from the device's file system.",
|
|
671
|
-
ref: '
|
|
671
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/files/pull-folder/',
|
|
672
672
|
parameters: [
|
|
673
673
|
{
|
|
674
674
|
name: 'path',
|
|
@@ -692,7 +692,7 @@ export default {
|
|
|
692
692
|
POST: {
|
|
693
693
|
command: 'toggleAirplaneMode',
|
|
694
694
|
description: 'Toggle airplane mode on device.',
|
|
695
|
-
ref: '
|
|
695
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/',
|
|
696
696
|
parameters: [],
|
|
697
697
|
support: {
|
|
698
698
|
android: {
|
|
@@ -705,7 +705,7 @@ export default {
|
|
|
705
705
|
POST: {
|
|
706
706
|
command: 'toggleData',
|
|
707
707
|
description: 'Switch the state of data service.',
|
|
708
|
-
ref: '
|
|
708
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/',
|
|
709
709
|
parameters: [],
|
|
710
710
|
support: {
|
|
711
711
|
android: {
|
|
@@ -718,7 +718,7 @@ export default {
|
|
|
718
718
|
POST: {
|
|
719
719
|
command: 'toggleWiFi',
|
|
720
720
|
description: 'Switch the state of the wifi service.',
|
|
721
|
-
ref: '
|
|
721
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/',
|
|
722
722
|
parameters: [],
|
|
723
723
|
support: {
|
|
724
724
|
android: {
|
|
@@ -731,7 +731,7 @@ export default {
|
|
|
731
731
|
POST: {
|
|
732
732
|
command: 'toggleLocationServices',
|
|
733
733
|
description: 'Switch the state of the location service.',
|
|
734
|
-
ref: '
|
|
734
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/',
|
|
735
735
|
parameters: [],
|
|
736
736
|
support: {
|
|
737
737
|
android: {
|
|
@@ -744,7 +744,7 @@ export default {
|
|
|
744
744
|
POST: {
|
|
745
745
|
command: 'toggleNetworkSpeed',
|
|
746
746
|
description: 'Set network speed (Emulator only)',
|
|
747
|
-
ref: '
|
|
747
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/',
|
|
748
748
|
parameters: [
|
|
749
749
|
{
|
|
750
750
|
name: 'netspeed',
|
|
@@ -764,7 +764,7 @@ export default {
|
|
|
764
764
|
POST: {
|
|
765
765
|
command: 'openNotifications',
|
|
766
766
|
description: 'Open Android notifications (Emulator only).',
|
|
767
|
-
ref: '
|
|
767
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/',
|
|
768
768
|
parameters: [],
|
|
769
769
|
support: {
|
|
770
770
|
android: {
|
|
@@ -777,7 +777,7 @@ export default {
|
|
|
777
777
|
POST: {
|
|
778
778
|
command: 'startActivity',
|
|
779
779
|
description: 'Start an Android activity by providing package name and activity name.',
|
|
780
|
-
ref: '
|
|
780
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/',
|
|
781
781
|
parameters: [
|
|
782
782
|
{
|
|
783
783
|
name: 'appPackage',
|
|
@@ -848,7 +848,7 @@ export default {
|
|
|
848
848
|
GET: {
|
|
849
849
|
command: 'getSystemBars',
|
|
850
850
|
description: 'Retrieve visibility and bounds information of the status and navigation bars.',
|
|
851
|
-
ref: '
|
|
851
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/',
|
|
852
852
|
parameters: [],
|
|
853
853
|
returns: {
|
|
854
854
|
type: 'object[]',
|
|
@@ -866,7 +866,7 @@ export default {
|
|
|
866
866
|
GET: {
|
|
867
867
|
command: 'getDeviceTime',
|
|
868
868
|
description: 'Get the time on the device.',
|
|
869
|
-
ref: '
|
|
869
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/system/system-time/',
|
|
870
870
|
parameters: [],
|
|
871
871
|
returns: {
|
|
872
872
|
type: 'string',
|
|
@@ -904,8 +904,8 @@ export default {
|
|
|
904
904
|
'/session/:sessionId/appium/simulator/touch_id': {
|
|
905
905
|
POST: {
|
|
906
906
|
command: 'touchId',
|
|
907
|
-
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](
|
|
908
|
-
ref: '
|
|
907
|
+
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.',
|
|
908
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/',
|
|
909
909
|
parameters: [
|
|
910
910
|
{
|
|
911
911
|
name: 'match',
|
|
@@ -925,7 +925,7 @@ export default {
|
|
|
925
925
|
POST: {
|
|
926
926
|
command: 'toggleEnrollTouchId',
|
|
927
927
|
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.",
|
|
928
|
-
ref: '
|
|
928
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/',
|
|
929
929
|
parameters: [
|
|
930
930
|
{
|
|
931
931
|
name: 'enabled',
|
|
@@ -945,8 +945,8 @@ export default {
|
|
|
945
945
|
'/session/:sessionId/appium/app/launch': {
|
|
946
946
|
POST: {
|
|
947
947
|
command: 'launchApp',
|
|
948
|
-
description: 'Launch an app on device. iOS tests with XCUITest can also use the `mobile: launchApp` method. See detailed [documentation](
|
|
949
|
-
ref: '
|
|
948
|
+
description: 'Launch an app on device. iOS tests with XCUITest can also use the `mobile: launchApp` method. See detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-launchapp).',
|
|
949
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/',
|
|
950
950
|
parameters: [],
|
|
951
951
|
support: {
|
|
952
952
|
ios: {
|
|
@@ -963,7 +963,7 @@ export default {
|
|
|
963
963
|
POST: {
|
|
964
964
|
command: 'closeApp',
|
|
965
965
|
description: 'Close an app on device.',
|
|
966
|
-
ref: '
|
|
966
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/',
|
|
967
967
|
parameters: [],
|
|
968
968
|
support: {
|
|
969
969
|
ios: {
|
|
@@ -979,8 +979,8 @@ export default {
|
|
|
979
979
|
'/session/:sessionId/appium/app/background': {
|
|
980
980
|
POST: {
|
|
981
981
|
command: 'background',
|
|
982
|
-
description: 'Send the currently running app for this session to the background. iOS tests with XCUITest can also use the `mobile: terminateApp` method to terminate the current app (see detailed [documentation](
|
|
983
|
-
ref: '
|
|
982
|
+
description: 'Send the currently running app for this session to the background. iOS tests with XCUITest can also use the `mobile: terminateApp` method to terminate the current app (see detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-terminateapp)), and the `mobile: activateApp` to activate an existing application on the device under test and moves it to the foreground (see detailed [documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management/index.html#mobile-activateapp)).',
|
|
983
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/',
|
|
984
984
|
parameters: [
|
|
985
985
|
{
|
|
986
986
|
name: 'seconds',
|
|
@@ -1005,7 +1005,7 @@ export default {
|
|
|
1005
1005
|
POST: {
|
|
1006
1006
|
command: 'endCoverage',
|
|
1007
1007
|
description: 'Get test coverage data.',
|
|
1008
|
-
ref: '
|
|
1008
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/end-test-coverage/',
|
|
1009
1009
|
parameters: [
|
|
1010
1010
|
{
|
|
1011
1011
|
name: 'intent',
|
|
@@ -1031,7 +1031,7 @@ export default {
|
|
|
1031
1031
|
POST: {
|
|
1032
1032
|
command: 'getStrings',
|
|
1033
1033
|
description: 'Get app strings.',
|
|
1034
|
-
ref: '
|
|
1034
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/',
|
|
1035
1035
|
parameters: [
|
|
1036
1036
|
{
|
|
1037
1037
|
name: 'language',
|
|
@@ -1121,7 +1121,7 @@ export default {
|
|
|
1121
1121
|
GET: {
|
|
1122
1122
|
command: 'getSettings',
|
|
1123
1123
|
description: 'Retrieve the current settings on the device.',
|
|
1124
|
-
ref: '
|
|
1124
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/session/settings/get-settings/',
|
|
1125
1125
|
parameters: [],
|
|
1126
1126
|
returns: {
|
|
1127
1127
|
type: 'object',
|
|
@@ -1144,7 +1144,7 @@ export default {
|
|
|
1144
1144
|
POST: {
|
|
1145
1145
|
command: 'updateSettings',
|
|
1146
1146
|
description: 'Update the current setting on the device.',
|
|
1147
|
-
ref: '
|
|
1147
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/session/settings/update-settings/',
|
|
1148
1148
|
parameters: [
|
|
1149
1149
|
{
|
|
1150
1150
|
name: 'settings',
|
|
@@ -1187,7 +1187,7 @@ export default {
|
|
|
1187
1187
|
POST: {
|
|
1188
1188
|
command: 'gsmCall',
|
|
1189
1189
|
description: 'Make GSM call (Emulator only).',
|
|
1190
|
-
ref: '
|
|
1190
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/',
|
|
1191
1191
|
parameters: [
|
|
1192
1192
|
{
|
|
1193
1193
|
name: 'phoneNumber',
|
|
@@ -1213,7 +1213,7 @@ export default {
|
|
|
1213
1213
|
POST: {
|
|
1214
1214
|
command: 'gsmSignal',
|
|
1215
1215
|
description: 'Set GSM signal strength (Emulator only).',
|
|
1216
|
-
ref: '
|
|
1216
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/',
|
|
1217
1217
|
parameters: [
|
|
1218
1218
|
{
|
|
1219
1219
|
name: 'signalStrength',
|
|
@@ -1239,7 +1239,7 @@ export default {
|
|
|
1239
1239
|
POST: {
|
|
1240
1240
|
command: 'powerCapacity',
|
|
1241
1241
|
description: 'Set the battery percentage (Emulator only).',
|
|
1242
|
-
ref: '
|
|
1242
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/',
|
|
1243
1243
|
parameters: [
|
|
1244
1244
|
{
|
|
1245
1245
|
name: 'percent',
|
|
@@ -1259,7 +1259,7 @@ export default {
|
|
|
1259
1259
|
POST: {
|
|
1260
1260
|
command: 'powerAC',
|
|
1261
1261
|
description: 'Set the state of the battery charger to connected or not (Emulator only).',
|
|
1262
|
-
ref: '
|
|
1262
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/',
|
|
1263
1263
|
parameters: [
|
|
1264
1264
|
{
|
|
1265
1265
|
name: 'state',
|
|
@@ -1279,7 +1279,7 @@ export default {
|
|
|
1279
1279
|
POST: {
|
|
1280
1280
|
command: 'gsmVoice',
|
|
1281
1281
|
description: 'Set GSM voice state (Emulator only).',
|
|
1282
|
-
ref: '
|
|
1282
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/',
|
|
1283
1283
|
parameters: [
|
|
1284
1284
|
{
|
|
1285
1285
|
name: 'state',
|
|
@@ -1299,7 +1299,7 @@ export default {
|
|
|
1299
1299
|
POST: {
|
|
1300
1300
|
command: 'sendSms',
|
|
1301
1301
|
description: 'Simulate an SMS message (Emulator only).',
|
|
1302
|
-
ref: '
|
|
1302
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/',
|
|
1303
1303
|
parameters: [
|
|
1304
1304
|
{
|
|
1305
1305
|
name: 'phoneNumber',
|
|
@@ -1325,7 +1325,7 @@ export default {
|
|
|
1325
1325
|
POST: {
|
|
1326
1326
|
command: 'fingerPrint',
|
|
1327
1327
|
description: 'Authenticate users by using their finger print scans on supported emulators.',
|
|
1328
|
-
ref: '
|
|
1328
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/',
|
|
1329
1329
|
parameters: [
|
|
1330
1330
|
{
|
|
1331
1331
|
name: 'fingerprintId',
|
|
@@ -1345,7 +1345,7 @@ export default {
|
|
|
1345
1345
|
POST: {
|
|
1346
1346
|
command: 'setClipboard',
|
|
1347
1347
|
description: 'Set the content of the system clipboard',
|
|
1348
|
-
ref: '
|
|
1348
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/',
|
|
1349
1349
|
parameters: [
|
|
1350
1350
|
{
|
|
1351
1351
|
name: 'content',
|
|
@@ -1377,7 +1377,7 @@ export default {
|
|
|
1377
1377
|
POST: {
|
|
1378
1378
|
command: 'getClipboard',
|
|
1379
1379
|
description: 'Get the content of the system clipboard',
|
|
1380
|
-
ref: '
|
|
1380
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/',
|
|
1381
1381
|
parameters: [
|
|
1382
1382
|
{
|
|
1383
1383
|
name: 'contentType',
|
|
@@ -1397,7 +1397,7 @@ export default {
|
|
|
1397
1397
|
POST: {
|
|
1398
1398
|
command: 'touchPerform',
|
|
1399
1399
|
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.",
|
|
1400
|
-
ref: '
|
|
1400
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/interactions/touch/touch-perform/',
|
|
1401
1401
|
parameters: [
|
|
1402
1402
|
{
|
|
1403
1403
|
name: 'actions',
|
|
@@ -1463,7 +1463,7 @@ export default {
|
|
|
1463
1463
|
POST: {
|
|
1464
1464
|
command: 'multiTouchPerform',
|
|
1465
1465
|
description: 'This functionality is only available from within a native context. Perform a multi touch action sequence.',
|
|
1466
|
-
ref: '
|
|
1466
|
+
ref: 'https://appium.github.io/appium.io/docs/en/commands/interactions/touch/multi-touch-perform/',
|
|
1467
1467
|
parameters: [
|
|
1468
1468
|
{
|
|
1469
1469
|
name: 'actions',
|
|
@@ -1563,7 +1563,7 @@ export default {
|
|
|
1563
1563
|
POST: {
|
|
1564
1564
|
command: 'compareImages',
|
|
1565
1565
|
description: 'Performs images comparison using OpenCV framework features. It is expected that both OpenCV framework and opencv4nodejs module are installed on the machine where Appium server is running.',
|
|
1566
|
-
ref: '
|
|
1566
|
+
ref: 'https://appium.github.io/appium.io/docs/en/writing-running-appium/image-comparison/',
|
|
1567
1567
|
parameters: [
|
|
1568
1568
|
{
|
|
1569
1569
|
name: 'mode',
|
|
@@ -54,7 +54,7 @@ export default {
|
|
|
54
54
|
returns: {
|
|
55
55
|
type: 'number',
|
|
56
56
|
name: 'connectionType',
|
|
57
|
-
description: 'see
|
|
57
|
+
description: 'see https://appium.github.io/appium.io/docs/en/writing-running-appium/other/network-connection/',
|
|
58
58
|
},
|
|
59
59
|
},
|
|
60
60
|
POST: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wdio/protocols",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.10.2",
|
|
4
4
|
"description": "Utility package providing information about automation protocols",
|
|
5
5
|
"author": "Christian Bromann <mail@bromann.dev>",
|
|
6
6
|
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-protocols",
|
|
@@ -27,5 +27,5 @@
|
|
|
27
27
|
"publishConfig": {
|
|
28
28
|
"access": "public"
|
|
29
29
|
},
|
|
30
|
-
"gitHead": "
|
|
30
|
+
"gitHead": "fb163d506af31d0c5e5328bfee07d55a56aa0034"
|
|
31
31
|
}
|