@wdio/protocols 9.24.0 → 9.26.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.
@@ -1,4 +1,4 @@
1
- import type { ProtocolCommandResponse, Context, StringsReturn, SettingsReturn } from '../types.js';
1
+ import type { ProtocolCommandResponse, Context, SettingsReturn } from '../types.js';
2
2
  export default interface AppiumCommands {
3
3
  /**
4
4
  * Appium Protocol Command
@@ -76,39 +76,39 @@ export default interface AppiumCommands {
76
76
  /**
77
77
  * Appium Protocol Command
78
78
  *
79
- * Perform a shake action on the device.
79
+ * Perform a shake action on the device. This is the raw Appium protocol endpoint. Prefer the `shake` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
80
80
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/
81
- * @deprecated Use `driver.execute('mobile: shake')` instead
81
+ * @deprecated Use the `shake` mobile command (`driver.shake()`) instead
82
82
  *
83
83
  */
84
- shake(): Promise<void>;
84
+ appiumShake(): Promise<void>;
85
85
  /**
86
86
  * Appium Protocol Command
87
87
  *
88
- * Lock the device.
88
+ * Lock the device. This is the raw Appium protocol endpoint. Prefer the `lock` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
89
89
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/
90
- * @deprecated Use `driver.execute('mobile: lock', { ... })` instead
90
+ * @deprecated Use the `lock` mobile command (`driver.lock()`) instead
91
91
  *
92
92
  */
93
- lock(seconds?: number): Promise<void>;
93
+ appiumLock(seconds?: number): Promise<void>;
94
94
  /**
95
95
  * Appium Protocol Command
96
96
  *
97
- * Unlock the device.
97
+ * Unlock the device. This is the raw Appium protocol endpoint. Prefer the `unlock` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
98
98
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/
99
- * @deprecated Use `driver.execute('mobile: unlock')` instead
99
+ * @deprecated Use the `unlock` mobile command (`driver.unlock()`) instead
100
100
  *
101
101
  */
102
- unlock(): Promise<void>;
102
+ appiumUnlock(): Promise<void>;
103
103
  /**
104
104
  * Appium Protocol Command
105
105
  *
106
- * Check whether the device is locked or not.
106
+ * Check whether the device is locked or not. This is the raw Appium protocol endpoint. Prefer the `isLocked` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
107
107
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/
108
- * @deprecated Use `driver.execute('mobile: isLocked')` instead
108
+ * @deprecated Use the `isLocked` mobile command (`driver.isLocked()`) instead
109
109
  *
110
110
  */
111
- isLocked(): Promise<boolean>;
111
+ appiumIsLocked(): Promise<boolean>;
112
112
  /**
113
113
  * Appium Protocol Command
114
114
  *
@@ -120,7 +120,7 @@ export default interface AppiumCommands {
120
120
  /**
121
121
  * Appium Protocol Command
122
122
  *
123
- * Stop recording screen
123
+ * Stop recording screen.
124
124
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/stop-recording-screen/
125
125
  *
126
126
  */
@@ -128,48 +128,48 @@ export default interface AppiumCommands {
128
128
  /**
129
129
  * Appium Protocol Command
130
130
  *
131
- * Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery.
131
+ * Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery. This is the raw Appium protocol endpoint. Prefer the `getPerformanceDataTypes` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
132
132
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/
133
- * @deprecated Use `driver.execute('mobile: getPerformanceDataTypes')` instead
133
+ * @deprecated Use the `getPerformanceDataTypes` mobile command (`driver.getPerformanceDataTypes()`) instead
134
134
  *
135
135
  */
136
- getPerformanceDataTypes(): Promise<string[]>;
136
+ appiumGetPerformanceDataTypes(): Promise<string[]>;
137
137
  /**
138
138
  * Appium Protocol Command
139
139
  *
140
- * Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery.
140
+ * Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery. This is the raw Appium protocol endpoint. Prefer the `getPerformanceData` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
141
141
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/
142
- * @deprecated Use `driver.execute('mobile: getPerformanceData', { ... })` instead
142
+ * @deprecated Use the `getPerformanceData` mobile command (`driver.getPerformanceData()`) instead
143
143
  *
144
144
  */
145
- getPerformanceData(packageName: string, dataType: string, dataReadTimeout?: number): Promise<string[]>;
145
+ appiumGetPerformanceData(packageName: string, dataType: string, dataReadTimeout?: number): Promise<string[]>;
146
146
  /**
147
147
  * Appium Protocol Command
148
148
  *
149
- * Press a particular key on the device.
149
+ * Press a particular key on the device. This is the raw Appium protocol endpoint. Prefer the `pressKeyCode` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
150
150
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/
151
- * @deprecated Use `driver.execute('mobile: pressKey', { ... })` instead
151
+ * @deprecated Use the `pressKeyCode` mobile command (`driver.pressKeyCode()`) instead
152
152
  *
153
153
  */
154
- pressKeyCode(keycode: number, metastate?: number, flags?: number): Promise<void>;
154
+ appiumPressKeyCode(keycode: number, metastate?: number, flags?: number): Promise<void>;
155
155
  /**
156
156
  * Appium Protocol Command
157
157
  *
158
- * Press and hold a particular key code on the device.
158
+ * Press and hold a particular key code on the device. This is the raw Appium protocol endpoint. Prefer the `longPressKeyCode` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
159
159
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/
160
- * @deprecated Use `driver.execute('mobile: pressKey', { ... })` instead
160
+ * @deprecated Use the `longPressKeyCode` mobile command (`driver.longPressKeyCode()`) instead
161
161
  *
162
162
  */
163
- longPressKeyCode(keycode: number, metastate?: number, flags?: number): Promise<void>;
163
+ appiumLongPressKeyCode(keycode: number, metastate?: number, flags?: number): Promise<void>;
164
164
  /**
165
165
  * Appium Protocol Command
166
166
  *
167
- * Send a key code to the device.
167
+ * Send a key code to the device. This is the raw Appium protocol endpoint. Prefer the `pressKeyCode` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
168
168
  * @ref https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints
169
- * @deprecated Use `driver.execute('mobile: pressKey', { ... })` instead
169
+ * @deprecated Use the `pressKeyCode` mobile command (`driver.pressKeyCode()`) instead
170
170
  *
171
171
  */
172
- sendKeyEvent(keycode: string, metastate?: string): Promise<void>;
172
+ appiumSendKeyEvent(keycode: string, metastate?: string): Promise<void>;
173
173
  /**
174
174
  * Appium Protocol Command
175
175
  *
@@ -181,21 +181,21 @@ export default interface AppiumCommands {
181
181
  /**
182
182
  * Appium Protocol Command
183
183
  *
184
- * Get the name of the current Android activity.
184
+ * Get the name of the current Android activity. This is the raw Appium protocol endpoint. Prefer the `getCurrentActivity` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
185
185
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/
186
- * @deprecated Use `driver.execute('mobile: getCurrentActivity')` instead
186
+ * @deprecated Use the `getCurrentActivity` mobile command (`driver.getCurrentActivity()`) instead
187
187
  *
188
188
  */
189
- getCurrentActivity(): Promise<string>;
189
+ appiumGetCurrentActivity(): Promise<string>;
190
190
  /**
191
191
  * Appium Protocol Command
192
192
  *
193
- * Get the name of the current Android package.
193
+ * Get the name of the current Android package. This is the raw Appium protocol endpoint. Prefer the `getCurrentPackage` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
194
194
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/
195
- * @deprecated Use `driver.execute('mobile: getCurrentPackage')` instead
195
+ * @deprecated Use the `getCurrentPackage` mobile command (`driver.getCurrentPackage()`) instead
196
196
  *
197
197
  */
198
- getCurrentPackage(): Promise<string>;
198
+ appiumGetCurrentPackage(): Promise<string>;
199
199
  /**
200
200
  * Appium Protocol Command
201
201
  *
@@ -239,11 +239,12 @@ export default interface AppiumCommands {
239
239
  /**
240
240
  * Appium Protocol Command
241
241
  *
242
- * Get the given app status on the device
242
+ * This is the raw Appium protocol endpoint. Prefer the `queryAppState` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers. Get the given app status on the device
243
243
  * @ref https://appium.io/docs/en/latest/reference/api/appium/#queryappstate
244
+ * @deprecated Use the `queryAppState` mobile command (`driver.queryAppState()`) instead
244
245
  *
245
246
  */
246
- queryAppState(appId?: string, bundleId?: string): Promise<number>;
247
+ appiumQueryAppState(appId?: string, bundleId?: string): Promise<number>;
247
248
  /**
248
249
  * Appium Protocol Command
249
250
  *
@@ -287,75 +288,75 @@ export default interface AppiumCommands {
287
288
  /**
288
289
  * Appium Protocol Command
289
290
  *
290
- * Toggle airplane mode on device.
291
+ * Toggle airplane mode on device. This is the raw Appium protocol endpoint. Prefer the `toggleAirplaneMode` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
291
292
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/
292
- * @deprecated Use `driver.execute('mobile: setConnectivity', { ... })` instead
293
+ * @deprecated Use the `toggleAirplaneMode` mobile command (`driver.toggleAirplaneMode()`) instead
293
294
  *
294
295
  */
295
- toggleAirplaneMode(): Promise<void>;
296
+ appiumToggleAirplaneMode(): Promise<void>;
296
297
  /**
297
298
  * Appium Protocol Command
298
299
  *
299
- * Switch the state of data service.
300
+ * Switch the state of data service. This is the raw Appium protocol endpoint. Prefer the `toggleData` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
300
301
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/
301
- * @deprecated Use `driver.execute('mobile: setConnectivity', { ... })` instead
302
+ * @deprecated Use the `toggleData` mobile command (`driver.toggleData()`) instead
302
303
  *
303
304
  */
304
- toggleData(): Promise<void>;
305
+ appiumToggleData(): Promise<void>;
305
306
  /**
306
307
  * Appium Protocol Command
307
308
  *
308
- * Switch the state of the wifi service.
309
+ * Switch the state of the wifi service. This is the raw Appium protocol endpoint. Prefer the `toggleWiFi` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
309
310
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/
310
- * @deprecated Use `driver.execute('mobile: setConnectivity', { ... })` instead
311
+ * @deprecated Use the `toggleWiFi` mobile command (`driver.toggleWiFi()`) instead
311
312
  *
312
313
  */
313
- toggleWiFi(): Promise<void>;
314
+ appiumToggleWiFi(): Promise<void>;
314
315
  /**
315
316
  * Appium Protocol Command
316
317
  *
317
- * Switch the state of the location service.
318
+ * Switch the state of the location service. This is the raw Appium protocol endpoint. Prefer the `toggleLocationServices` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
318
319
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/
319
- * @deprecated Use `driver.execute('mobile: toggleGps')` instead
320
+ * @deprecated Use the `toggleLocationServices` mobile command (`driver.toggleLocationServices()`) instead
320
321
  *
321
322
  */
322
- toggleLocationServices(): Promise<void>;
323
+ appiumToggleLocationServices(): Promise<void>;
323
324
  /**
324
325
  * Appium Protocol Command
325
326
  *
326
- * Set network speed (Emulator only)
327
+ * Set network speed (Emulator only). This is the raw Appium protocol endpoint. Prefer the `toggleNetworkSpeed` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
327
328
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/
328
- * @deprecated Use `driver.execute('mobile: networkSpeed', { ... })` instead
329
+ * @deprecated Use the `toggleNetworkSpeed` mobile command (`driver.toggleNetworkSpeed()`) instead
329
330
  *
330
331
  */
331
- toggleNetworkSpeed(netspeed: string): Promise<void>;
332
+ appiumToggleNetworkSpeed(netspeed: string): Promise<void>;
332
333
  /**
333
334
  * Appium Protocol Command
334
335
  *
335
- * Open Android notifications.
336
+ * Open Android notifications. This is the raw Appium protocol endpoint. Prefer the `openNotifications` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
336
337
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/
337
- * @deprecated Use `driver.execute('mobile: openNotifications')` or `driver.execute('mobile: statusBar', { ... })` instead
338
+ * @deprecated Use the `openNotifications` mobile command (`driver.openNotifications()`) instead
338
339
  *
339
340
  */
340
- openNotifications(): Promise<void>;
341
+ appiumOpenNotifications(): Promise<void>;
341
342
  /**
342
343
  * Appium Protocol Command
343
344
  *
344
- * Start an Android activity by providing package name and activity name.
345
+ * Start an Android activity by providing package name and activity name. This is the raw Appium protocol endpoint. Prefer the `startActivity` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
345
346
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/
346
- * @deprecated Use `driver.execute('mobile: startActivity', { ... })` instead
347
+ * @deprecated Use the `startActivity` mobile command (`driver.startActivity()`) instead
347
348
  *
348
349
  */
349
- startActivity(appPackage: string, appActivity: string, appWaitPackage?: string, appWaitActivity?: string, intentAction?: string, intentCategory?: string, intentFlags?: string, optionalIntentArguments?: string, dontStopAppOnReset?: string): Promise<void>;
350
+ appiumStartActivity(appPackage: string, appActivity: string, appWaitPackage?: string, appWaitActivity?: string, intentAction?: string, intentCategory?: string, intentFlags?: string, optionalIntentArguments?: string, dontStopAppOnReset?: string): Promise<void>;
350
351
  /**
351
352
  * Appium Protocol Command
352
353
  *
353
- * Retrieve visibility and bounds information of the status and navigation bars.
354
+ * Retrieve visibility and bounds information of the status and navigation bars. This is the raw Appium protocol endpoint. Prefer the `getSystemBars` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
354
355
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/
355
- * @deprecated Use `driver.execute('mobile: getSystemBars')` instead
356
+ * @deprecated Use the `getSystemBars` mobile command (`driver.getSystemBars()`) instead
356
357
  *
357
358
  */
358
- getSystemBars(): Promise<object[]>;
359
+ appiumGetSystemBars(): Promise<object[]>;
359
360
  /**
360
361
  * Appium Protocol Command
361
362
  *
@@ -367,57 +368,57 @@ export default interface AppiumCommands {
367
368
  /**
368
369
  * Appium Protocol Command
369
370
  *
370
- * Get display density from device.
371
+ * Get display density from device. This is the raw Appium protocol endpoint. Prefer the `getDisplayDensity` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
371
372
  * @ref https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints
372
- * @deprecated Use `driver.execute('mobile: getDisplayDensity')` instead
373
+ * @deprecated Use the `getDisplayDensity` mobile command (`driver.getDisplayDensity()`) instead
373
374
  *
374
375
  */
375
- getDisplayDensity(): Promise<any>;
376
+ appiumGetDisplayDensity(): Promise<any>;
376
377
  /**
377
378
  * Appium Protocol Command
378
379
  *
379
380
  * 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.
380
381
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/
381
- * @deprecated Use `driver.execute('mobile: sendBiometricMatch', { ... })` instead
382
+ * @deprecated Use the `touchId` mobile command (`driver.touchId()`) instead
382
383
  *
383
384
  */
384
- touchId(match: boolean): Promise<void>;
385
+ appiumTouchId(match: boolean): Promise<void>;
385
386
  /**
386
387
  * Appium Protocol Command
387
388
  *
388
389
  * 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.
389
390
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/
390
- * @deprecated Use `driver.execute('mobile: enrollBiometric', { ... })` instead
391
+ * @deprecated Use the `toggleEnrollTouchId` mobile command (`driver.toggleEnrollTouchId()`) instead
391
392
  *
392
393
  */
393
- toggleEnrollTouchId(enabled?: boolean): Promise<void>;
394
+ appiumToggleEnrollTouchId(enabled?: boolean): Promise<void>;
394
395
  /**
395
396
  * Appium Protocol Command
396
397
  *
397
- * Launch an app on device.
398
+ * Launch an app on device. This is the raw Appium protocol endpoint. Prefer the `launchApp` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
398
399
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/
399
- * @deprecated Use `driver.execute('mobile: launchApp', { ... })` (iOS) or `driver.execute('mobile: activateApp', { ... })` (Android) instead
400
+ * @deprecated Use the `launchApp` mobile command (`driver.launchApp()`) instead
400
401
  *
401
402
  */
402
- launchApp(): Promise<void>;
403
+ appiumLaunchApp(): Promise<void>;
403
404
  /**
404
405
  * Appium Protocol Command
405
406
  *
406
- * Close an app on device.
407
+ * Close an app on device. This is the raw Appium protocol endpoint. Prefer the `closeApp` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
407
408
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/
408
- * @deprecated Use `driver.execute('mobile: terminateApp', { ... })` instead
409
+ * @deprecated Use the `closeApp` mobile command (`driver.closeApp()`) instead
409
410
  *
410
411
  */
411
- closeApp(): Promise<void>;
412
+ appiumCloseApp(): Promise<void>;
412
413
  /**
413
414
  * Appium Protocol Command
414
415
  *
415
- * Send the currently running app for this session to the background.
416
+ * Send the currently running app for this session to the background. This is the raw Appium protocol endpoint. Prefer the `background` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
416
417
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/
417
- * @deprecated Use `driver.execute('mobile: backgroundApp', { ... })` instead
418
+ * @deprecated Use the `background` mobile command (`driver.background()`) instead
418
419
  *
419
420
  */
420
- background(seconds: (number | null)): Promise<void>;
421
+ appiumBackground(seconds: (number | null)): Promise<void>;
421
422
  /**
422
423
  * Appium Protocol Command
423
424
  *
@@ -430,12 +431,12 @@ export default interface AppiumCommands {
430
431
  /**
431
432
  * Appium Protocol Command
432
433
  *
433
- * Get app strings.
434
+ * Get app strings. This is the raw Appium protocol endpoint. Prefer the `getStrings` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
434
435
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/
435
- * @deprecated Use `driver.execute('mobile: getAppStrings', { ... })` instead
436
+ * @deprecated Use the `getStrings` mobile command (`driver.getStrings()`) instead
436
437
  *
437
438
  */
438
- getStrings(language?: string, stringFile?: string): Promise<StringsReturn>;
439
+ appiumGetStrings(language?: string, stringFile?: string): Promise<ProtocolCommandResponse>;
439
440
  /**
440
441
  * Appium Protocol Command
441
442
  *
@@ -482,84 +483,84 @@ export default interface AppiumCommands {
482
483
  /**
483
484
  * Appium Protocol Command
484
485
  *
485
- * Make GSM call (Emulator only).
486
+ * Make GSM call (Emulator only). This is the raw Appium protocol endpoint. Prefer the `gsmCall` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
486
487
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/
487
- * @deprecated Use `driver.execute('mobile: gsmCall', { ... })` instead
488
+ * @deprecated Use the `gsmCall` mobile command (`driver.gsmCall()`) instead
488
489
  *
489
490
  */
490
- gsmCall(phoneNumber: string, action: string): Promise<void>;
491
+ appiumGsmCall(phoneNumber: string, action: string): Promise<void>;
491
492
  /**
492
493
  * Appium Protocol Command
493
494
  *
494
- * Set GSM signal strength (Emulator only).
495
+ * Set GSM signal strength (Emulator only). This is the raw Appium protocol endpoint. Prefer the `gsmSignal` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
495
496
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/
496
- * @deprecated Use `driver.execute('mobile: gsmSignal', { ... })` instead
497
+ * @deprecated Use the `gsmSignal` mobile command (`driver.gsmSignal()`) instead
497
498
  *
498
499
  */
499
- gsmSignal(signalStrength: string, signalStrengh?: string): Promise<void>;
500
+ appiumGsmSignal(signalStrength: string, signalStrengh?: string): Promise<void>;
500
501
  /**
501
502
  * Appium Protocol Command
502
503
  *
503
- * Set the battery percentage (Emulator only).
504
+ * Set the battery percentage (Emulator only). This is the raw Appium protocol endpoint. Prefer the `powerCapacity` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
504
505
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/
505
- * @deprecated Use `driver.execute('mobile: powerCapacity', { ... })` instead
506
+ * @deprecated Use the `powerCapacity` mobile command (`driver.powerCapacity()`) instead
506
507
  *
507
508
  */
508
- powerCapacity(percent: number): Promise<void>;
509
+ appiumPowerCapacity(percent: number): Promise<void>;
509
510
  /**
510
511
  * Appium Protocol Command
511
512
  *
512
- * Set the state of the battery charger to connected or not (Emulator only).
513
+ * Set the state of the battery charger to connected or not (Emulator only). This is the raw Appium protocol endpoint. Prefer the `powerAC` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
513
514
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/
514
- * @deprecated Use `driver.execute('mobile: powerAC', { ... })` instead
515
+ * @deprecated Use the `powerAC` mobile command (`driver.powerAC()`) instead
515
516
  *
516
517
  */
517
- powerAC(state: string): Promise<void>;
518
+ appiumPowerAC(state: string): Promise<void>;
518
519
  /**
519
520
  * Appium Protocol Command
520
521
  *
521
- * Set GSM voice state (Emulator only).
522
+ * Set GSM voice state (Emulator only). This is the raw Appium protocol endpoint. Prefer the `gsmVoice` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
522
523
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/
523
- * @deprecated Use `driver.execute('mobile: gsmVoice', { ... })` instead
524
+ * @deprecated Use the `gsmVoice` mobile command (`driver.gsmVoice()`) instead
524
525
  *
525
526
  */
526
- gsmVoice(state: string): Promise<void>;
527
+ appiumGsmVoice(state: string): Promise<void>;
527
528
  /**
528
529
  * Appium Protocol Command
529
530
  *
530
- * Simulate an SMS message (Emulator only).
531
+ * Simulate an SMS message (Emulator only). This is the raw Appium protocol endpoint. Prefer the `sendSms` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
531
532
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/
532
- * @deprecated Use `driver.execute('mobile: sendSms', { ... })` instead
533
+ * @deprecated Use the `sendSms` mobile command (`driver.sendSms()`) instead
533
534
  *
534
535
  */
535
- sendSms(phoneNumber: string, message: string): Promise<void>;
536
+ appiumSendSms(phoneNumber: string, message: string): Promise<void>;
536
537
  /**
537
538
  * Appium Protocol Command
538
539
  *
539
- * Authenticate users by using their finger print scans on supported emulators.
540
+ * Authenticate users by using their finger print scans on supported emulators. This is the raw Appium protocol endpoint. Prefer the `fingerPrint` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
540
541
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/
541
- * @deprecated Use `driver.execute('mobile: fingerPrint', { ... })` instead
542
+ * @deprecated Use the `fingerPrint` mobile command (`driver.fingerPrint()`) instead
542
543
  *
543
544
  */
544
- fingerPrint(fingerprintId: number): Promise<void>;
545
+ appiumFingerPrint(fingerprintId: number): Promise<void>;
545
546
  /**
546
547
  * Appium Protocol Command
547
548
  *
548
- * Set the content of the system clipboard
549
+ * Set the content of the system clipboard. This is the raw Appium protocol endpoint. Prefer the `setClipboard` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
549
550
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/
550
- * @deprecated Use `driver.execute('mobile: setClipboard', { ... })` instead
551
+ * @deprecated Use the `setClipboard` mobile command (`driver.setClipboard()`) instead
551
552
  *
552
553
  */
553
- setClipboard(content: string, contentType?: string, label?: string): Promise<string>;
554
+ appiumSetClipboard(content: string, contentType?: string, label?: string): Promise<string>;
554
555
  /**
555
556
  * Appium Protocol Command
556
557
  *
557
- * Get the content of the system clipboard
558
+ * Get the content of the system clipboard. This is the raw Appium protocol endpoint. Prefer the `getClipboard` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.
558
559
  * @ref https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/
559
- * @deprecated Use `driver.execute('mobile: getClipboard', { ... })` instead
560
+ * @deprecated Use the `getClipboard` mobile command (`driver.getClipboard()`) instead
560
561
  *
561
562
  */
562
- getClipboard(contentType?: string): Promise<string>;
563
+ appiumGetClipboard(contentType?: string): Promise<string>;
563
564
  /**
564
565
  * Appium Protocol Command
565
566
  *
@@ -1 +1 @@
1
- {"version":3,"file":"appium.d.ts","sourceRoot":"","sources":["../../src/commands/appium.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAGlG,MAAM,CAAC,OAAO,WAAW,cAAc;IAEnC;;;;;;OAMG;IACH,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEjC;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,UAAU,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAErC;;;;;;OAMG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,iBAAiB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAExC;;;;;;OAMG;IACH,iBAAiB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEtD;;;;;;OAMG;IACH,mBAAmB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAExD;;;;;;OAMG;IACH,4BAA4B,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEjE;;;;;;;OAOG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB;;;;;;;OAOG;IACH,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7B;;;;;;OAMG;IACH,oBAAoB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;;;OAMG;IACH,mBAAmB,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjH;;;;;;;OAOG;IACH,uBAAuB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAE7C;;;;;;;OAOG;IACH,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEvG;;;;;;;OAOG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjF;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErF;;;;;;;OAOG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;;;OAMG;IACH,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;;;;;OAOG;IACH,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAErC;;;;;;OAMG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhF;;;;;;OAMG;IACH,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjF;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjF;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpE;;;;;;OAMG;IACH,aAAa,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAElE;;;;;;OAMG;IACH,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjG;;;;;;OAMG;IACH,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpC;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAExC;;;;;;OAMG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1C;;;;;;;OAOG;IACH,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;;;;OAOG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B;;;;;;;OAOG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B;;;;;;;OAOG;IACH,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;;;;OAOG;IACH,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnC;;;;;;;OAOG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,uBAAuB,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9P;;;;;;;OAOG;IACH,aAAa,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEnC;;;;;;OAMG;IACH,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAElC;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC;;;;;;;OAOG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;;;;;;OAOG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,EAAE,CAAC,MAAM,GAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;;;;;OAOG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;;;;;OAOG;IACH,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE3E;;;;;;;OAOG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;;;;;;OAOG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,WAAW,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;;OAOG;IACH,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5D;;;;;;;OAOG;IACH,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzE;;;;;;;OAOG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC;;;;;;;OAOG;IACH,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;;;;;OAOG;IACH,WAAW,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;;;;;OAOG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAErF;;;;;;;OAOG;IACH,YAAY,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;;;OAMG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEvG;;;;;;OAMG;IACH,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,GAAC,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEtE;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEzH;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEvE;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtC;;;;;;OAMG;IACH,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC;;;;;;OAMG;IACH,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;;;;;OAMG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEpE;;;;;;;OAOG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAExE;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;;;;OAOG;IACH,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;;OAOG;IACH,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElI;;;;;;OAMG;IACH,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;OAMG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;;;OAMG;IACH,cAAc,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEnD;;;;;;OAMG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD"}
1
+ {"version":3,"file":"appium.d.ts","sourceRoot":"","sources":["../../src/commands/appium.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAGnF,MAAM,CAAC,OAAO,WAAW,cAAc;IAEnC;;;;;;OAMG;IACH,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEjC;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,UAAU,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAErC;;;;;;OAMG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,iBAAiB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAExC;;;;;;OAMG;IACH,iBAAiB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEtD;;;;;;OAMG;IACH,mBAAmB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAExD;;;;;;OAMG;IACH,4BAA4B,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEjE;;;;;;;OAOG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;;;;OAOG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;;;;;OAOG;IACH,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC;;;;;;OAMG;IACH,oBAAoB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;;;OAMG;IACH,mBAAmB,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjH;;;;;;;OAOG;IACH,6BAA6B,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEnD;;;;;;;OAOG;IACH,wBAAwB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAE7G;;;;;;;OAOG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvF;;;;;;;OAOG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3F;;;;;;;OAOG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvE;;;;;;OAMG;IACH,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;;;;;OAOG;IACH,wBAAwB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5C;;;;;;;OAOG;IACH,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhF;;;;;;OAMG;IACH,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjF;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjF;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpE;;;;;;;OAOG;IACH,mBAAmB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAExE;;;;;;OAMG;IACH,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjG;;;;;;OAMG;IACH,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpC;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAExC;;;;;;OAMG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1C;;;;;;;OAOG;IACH,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;;;OAOG;IACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;;;;;;OAOG;IACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;;;;;;OAOG;IACH,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;;;;;;OAOG;IACH,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;;;;;OAOG;IACH,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,uBAAuB,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpQ;;;;;;;OAOG;IACH,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;;OAOG;IACH,yBAAyB,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5D;;;;;;;OAOG;IACH,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,EAAE,CAAC,MAAM,GAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;OAOG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;;;;;OAOG;IACH,gBAAgB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAE3F;;;;;;;OAOG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;;;;;;OAOG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,WAAW,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;IAEvC;;;;;;OAMG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;;OAOG;IACH,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;;;;;;OAOG;IACH,eAAe,CAAC,cAAc,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/E;;;;;;;OAOG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;;;;OAOG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;;;;OAOG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;;OAOG;IACH,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE;;;;;;;OAOG;IACH,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;OAOG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3F;;;;;;;OAOG;IACH,kBAAkB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;;;OAMG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEvG;;;;;;OAMG;IACH,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,GAAC,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEtE;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEzH;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;;;;OAOG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEvE;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtC;;;;;;OAMG;IACH,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC;;;;;;OAMG;IACH,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;;;;;OAMG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEpE;;;;;;;OAOG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAExE;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;;;;OAOG;IACH,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;;OAOG;IACH,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElI;;;;;;OAMG;IACH,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;OAMG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;;;OAMG;IACH,cAAc,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEnD;;;;;;OAMG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD"}
package/build/index.js CHANGED
@@ -3106,10 +3106,10 @@ var appium_default = {
3106
3106
  },
3107
3107
  "/session/:sessionId/appium/device/shake": {
3108
3108
  POST: {
3109
- command: "shake",
3110
- description: "Perform a shake action on the device.",
3109
+ command: "appiumShake",
3110
+ description: "Perform a shake action on the device. This is the raw Appium protocol endpoint. Prefer the `shake` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3111
3111
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/",
3112
- deprecated: "Use `driver.execute('mobile: shake')` instead",
3112
+ deprecated: "Use the `shake` mobile command (`driver.shake()`) instead",
3113
3113
  parameters: [],
3114
3114
  support: {
3115
3115
  ios: {
@@ -3121,10 +3121,10 @@ var appium_default = {
3121
3121
  },
3122
3122
  "/session/:sessionId/appium/device/lock": {
3123
3123
  POST: {
3124
- command: "lock",
3125
- description: "Lock the device.",
3124
+ command: "appiumLock",
3125
+ description: "Lock the device. This is the raw Appium protocol endpoint. Prefer the `lock` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3126
3126
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/",
3127
- deprecated: "Use `driver.execute('mobile: lock', { ... })` instead",
3127
+ deprecated: "Use the `lock` mobile command (`driver.lock()`) instead",
3128
3128
  parameters: [
3129
3129
  {
3130
3130
  name: "seconds",
@@ -3148,10 +3148,10 @@ var appium_default = {
3148
3148
  },
3149
3149
  "/session/:sessionId/appium/device/unlock": {
3150
3150
  POST: {
3151
- command: "unlock",
3152
- description: "Unlock the device.",
3151
+ command: "appiumUnlock",
3152
+ description: "Unlock the device. This is the raw Appium protocol endpoint. Prefer the `unlock` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3153
3153
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/",
3154
- deprecated: "Use `driver.execute('mobile: unlock')` instead",
3154
+ deprecated: "Use the `unlock` mobile command (`driver.unlock()`) instead",
3155
3155
  parameters: [],
3156
3156
  support: {
3157
3157
  android: {
@@ -3165,10 +3165,10 @@ var appium_default = {
3165
3165
  },
3166
3166
  "/session/:sessionId/appium/device/is_locked": {
3167
3167
  POST: {
3168
- command: "isLocked",
3169
- description: "Check whether the device is locked or not.",
3168
+ command: "appiumIsLocked",
3169
+ description: "Check whether the device is locked or not. This is the raw Appium protocol endpoint. Prefer the `isLocked` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3170
3170
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/",
3171
- deprecated: "Use `driver.execute('mobile: isLocked')` instead",
3171
+ deprecated: "Use the `isLocked` mobile command (`driver.isLocked()`) instead",
3172
3172
  parameters: [],
3173
3173
  returns: {
3174
3174
  type: "boolean",
@@ -3214,7 +3214,7 @@ var appium_default = {
3214
3214
  "/session/:sessionId/appium/stop_recording_screen": {
3215
3215
  POST: {
3216
3216
  command: "stopRecordingScreen",
3217
- description: "Stop recording screen",
3217
+ description: "Stop recording screen.",
3218
3218
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/stop-recording-screen/",
3219
3219
  parameters: [
3220
3220
  {
@@ -3262,10 +3262,10 @@ var appium_default = {
3262
3262
  },
3263
3263
  "/session/:sessionId/appium/performanceData/types": {
3264
3264
  POST: {
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.",
3265
+ command: "appiumGetPerformanceDataTypes",
3266
+ description: "Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery. This is the raw Appium protocol endpoint. Prefer the `getPerformanceDataTypes` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3267
3267
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/",
3268
- deprecated: "Use `driver.execute('mobile: getPerformanceDataTypes')` instead",
3268
+ deprecated: "Use the `getPerformanceDataTypes` mobile command (`driver.getPerformanceDataTypes()`) instead",
3269
3269
  parameters: [],
3270
3270
  returns: {
3271
3271
  type: "string[]",
@@ -3281,10 +3281,10 @@ var appium_default = {
3281
3281
  },
3282
3282
  "/session/:sessionId/appium/getPerformanceData": {
3283
3283
  POST: {
3284
- command: "getPerformanceData",
3285
- description: "Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery.",
3284
+ command: "appiumGetPerformanceData",
3285
+ description: "Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery. This is the raw Appium protocol endpoint. Prefer the `getPerformanceData` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3286
3286
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/",
3287
- deprecated: "Use `driver.execute('mobile: getPerformanceData', { ... })` instead",
3287
+ deprecated: "Use the `getPerformanceData` mobile command (`driver.getPerformanceData()`) instead",
3288
3288
  parameters: [
3289
3289
  {
3290
3290
  name: "packageName",
@@ -3319,10 +3319,10 @@ var appium_default = {
3319
3319
  },
3320
3320
  "/session/:sessionId/appium/device/press_keycode": {
3321
3321
  POST: {
3322
- command: "pressKeyCode",
3323
- description: "Press a particular key on the device.",
3322
+ command: "appiumPressKeyCode",
3323
+ description: "Press a particular key on the device. This is the raw Appium protocol endpoint. Prefer the `pressKeyCode` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3324
3324
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/",
3325
- deprecated: "Use `driver.execute('mobile: pressKey', { ... })` instead",
3325
+ deprecated: "Use the `pressKeyCode` mobile command (`driver.pressKeyCode()`) instead",
3326
3326
  parameters: [
3327
3327
  {
3328
3328
  name: "keycode",
@@ -3352,10 +3352,10 @@ var appium_default = {
3352
3352
  },
3353
3353
  "/session/:sessionId/appium/device/long_press_keycode": {
3354
3354
  POST: {
3355
- command: "longPressKeyCode",
3356
- description: "Press and hold a particular key code on the device.",
3355
+ command: "appiumLongPressKeyCode",
3356
+ description: "Press and hold a particular key code on the device. This is the raw Appium protocol endpoint. Prefer the `longPressKeyCode` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3357
3357
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/",
3358
- deprecated: "Use `driver.execute('mobile: pressKey', { ... })` instead",
3358
+ deprecated: "Use the `longPressKeyCode` mobile command (`driver.longPressKeyCode()`) instead",
3359
3359
  parameters: [
3360
3360
  {
3361
3361
  name: "keycode",
@@ -3385,10 +3385,10 @@ var appium_default = {
3385
3385
  },
3386
3386
  "/session/:sessionId/appium/device/keyevent": {
3387
3387
  POST: {
3388
- command: "sendKeyEvent",
3389
- description: "Send a key code to the device.",
3388
+ command: "appiumSendKeyEvent",
3389
+ description: "Send a key code to the device. This is the raw Appium protocol endpoint. Prefer the `pressKeyCode` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3390
3390
  ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
3391
- deprecated: "Use `driver.execute('mobile: pressKey', { ... })` instead",
3391
+ deprecated: "Use the `pressKeyCode` mobile command (`driver.pressKeyCode()`) instead",
3392
3392
  parameters: [
3393
3393
  {
3394
3394
  name: "keycode",
@@ -3450,10 +3450,10 @@ var appium_default = {
3450
3450
  },
3451
3451
  "/session/:sessionId/appium/device/current_activity": {
3452
3452
  GET: {
3453
- command: "getCurrentActivity",
3454
- description: "Get the name of the current Android activity.",
3453
+ command: "appiumGetCurrentActivity",
3454
+ description: "Get the name of the current Android activity. This is the raw Appium protocol endpoint. Prefer the `getCurrentActivity` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3455
3455
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/",
3456
- deprecated: "Use `driver.execute('mobile: getCurrentActivity')` instead",
3456
+ deprecated: "Use the `getCurrentActivity` mobile command (`driver.getCurrentActivity()`) instead",
3457
3457
  parameters: [],
3458
3458
  returns: {
3459
3459
  type: "string",
@@ -3469,10 +3469,10 @@ var appium_default = {
3469
3469
  },
3470
3470
  "/session/:sessionId/appium/device/current_package": {
3471
3471
  GET: {
3472
- command: "getCurrentPackage",
3473
- description: "Get the name of the current Android package.",
3472
+ command: "appiumGetCurrentPackage",
3473
+ description: "Get the name of the current Android package. This is the raw Appium protocol endpoint. Prefer the `getCurrentPackage` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3474
3474
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/",
3475
- deprecated: "Use `driver.execute('mobile: getCurrentPackage')` instead",
3475
+ deprecated: "Use the `getCurrentPackage` mobile command (`driver.getCurrentPackage()`) instead",
3476
3476
  parameters: [],
3477
3477
  returns: {
3478
3478
  type: "string",
@@ -3664,8 +3664,9 @@ var appium_default = {
3664
3664
  },
3665
3665
  "/session/:sessionId/appium/device/app_state": {
3666
3666
  POST: {
3667
- command: "queryAppState",
3668
- description: "Get the given app status on the device",
3667
+ command: "appiumQueryAppState",
3668
+ description: "This is the raw Appium protocol endpoint. Prefer the `queryAppState` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers. Get the given app status on the device",
3669
+ deprecated: "Use the `queryAppState` mobile command (`driver.queryAppState()`) instead",
3669
3670
  ref: "https://appium.io/docs/en/latest/reference/api/appium/#queryappstate",
3670
3671
  parameters: [
3671
3672
  {
@@ -3865,10 +3866,10 @@ var appium_default = {
3865
3866
  },
3866
3867
  "/session/:sessionId/appium/device/toggle_airplane_mode": {
3867
3868
  POST: {
3868
- command: "toggleAirplaneMode",
3869
- description: "Toggle airplane mode on device.",
3869
+ command: "appiumToggleAirplaneMode",
3870
+ description: "Toggle airplane mode on device. This is the raw Appium protocol endpoint. Prefer the `toggleAirplaneMode` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3870
3871
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/",
3871
- deprecated: "Use `driver.execute('mobile: setConnectivity', { ... })` instead",
3872
+ deprecated: "Use the `toggleAirplaneMode` mobile command (`driver.toggleAirplaneMode()`) instead",
3872
3873
  parameters: [],
3873
3874
  support: {
3874
3875
  android: {
@@ -3879,10 +3880,10 @@ var appium_default = {
3879
3880
  },
3880
3881
  "/session/:sessionId/appium/device/toggle_data": {
3881
3882
  POST: {
3882
- command: "toggleData",
3883
- description: "Switch the state of data service.",
3883
+ command: "appiumToggleData",
3884
+ description: "Switch the state of data service. This is the raw Appium protocol endpoint. Prefer the `toggleData` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3884
3885
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/",
3885
- deprecated: "Use `driver.execute('mobile: setConnectivity', { ... })` instead",
3886
+ deprecated: "Use the `toggleData` mobile command (`driver.toggleData()`) instead",
3886
3887
  parameters: [],
3887
3888
  support: {
3888
3889
  android: {
@@ -3893,10 +3894,10 @@ var appium_default = {
3893
3894
  },
3894
3895
  "/session/:sessionId/appium/device/toggle_wifi": {
3895
3896
  POST: {
3896
- command: "toggleWiFi",
3897
- description: "Switch the state of the wifi service.",
3897
+ command: "appiumToggleWiFi",
3898
+ description: "Switch the state of the wifi service. This is the raw Appium protocol endpoint. Prefer the `toggleWiFi` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3898
3899
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/",
3899
- deprecated: "Use `driver.execute('mobile: setConnectivity', { ... })` instead",
3900
+ deprecated: "Use the `toggleWiFi` mobile command (`driver.toggleWiFi()`) instead",
3900
3901
  parameters: [],
3901
3902
  support: {
3902
3903
  android: {
@@ -3907,10 +3908,10 @@ var appium_default = {
3907
3908
  },
3908
3909
  "/session/:sessionId/appium/device/toggle_location_services": {
3909
3910
  POST: {
3910
- command: "toggleLocationServices",
3911
- description: "Switch the state of the location service.",
3911
+ command: "appiumToggleLocationServices",
3912
+ description: "Switch the state of the location service. This is the raw Appium protocol endpoint. Prefer the `toggleLocationServices` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3912
3913
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/",
3913
- deprecated: "Use `driver.execute('mobile: toggleGps')` instead",
3914
+ deprecated: "Use the `toggleLocationServices` mobile command (`driver.toggleLocationServices()`) instead",
3914
3915
  parameters: [],
3915
3916
  support: {
3916
3917
  android: {
@@ -3921,10 +3922,10 @@ var appium_default = {
3921
3922
  },
3922
3923
  "/session/:sessionId/appium/device/network_speed": {
3923
3924
  POST: {
3924
- command: "toggleNetworkSpeed",
3925
- description: "Set network speed (Emulator only)",
3925
+ command: "appiumToggleNetworkSpeed",
3926
+ description: "Set network speed (Emulator only). This is the raw Appium protocol endpoint. Prefer the `toggleNetworkSpeed` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3926
3927
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/",
3927
- deprecated: "Use `driver.execute('mobile: networkSpeed', { ... })` instead",
3928
+ deprecated: "Use the `toggleNetworkSpeed` mobile command (`driver.toggleNetworkSpeed()`) instead",
3928
3929
  parameters: [
3929
3930
  {
3930
3931
  name: "netspeed",
@@ -3942,10 +3943,10 @@ var appium_default = {
3942
3943
  },
3943
3944
  "/session/:sessionId/appium/device/open_notifications": {
3944
3945
  POST: {
3945
- command: "openNotifications",
3946
- description: "Open Android notifications.",
3946
+ command: "appiumOpenNotifications",
3947
+ description: "Open Android notifications. This is the raw Appium protocol endpoint. Prefer the `openNotifications` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3947
3948
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/",
3948
- deprecated: "Use `driver.execute('mobile: openNotifications')` or `driver.execute('mobile: statusBar', { ... })` instead",
3949
+ deprecated: "Use the `openNotifications` mobile command (`driver.openNotifications()`) instead",
3949
3950
  parameters: [],
3950
3951
  support: {
3951
3952
  android: {
@@ -3956,10 +3957,10 @@ var appium_default = {
3956
3957
  },
3957
3958
  "/session/:sessionId/appium/device/start_activity": {
3958
3959
  POST: {
3959
- command: "startActivity",
3960
- description: "Start an Android activity by providing package name and activity name.",
3960
+ command: "appiumStartActivity",
3961
+ description: "Start an Android activity by providing package name and activity name. This is the raw Appium protocol endpoint. Prefer the `startActivity` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
3961
3962
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/",
3962
- deprecated: "Use `driver.execute('mobile: startActivity', { ... })` instead",
3963
+ deprecated: "Use the `startActivity` mobile command (`driver.startActivity()`) instead",
3963
3964
  parameters: [
3964
3965
  {
3965
3966
  name: "appPackage",
@@ -4028,10 +4029,10 @@ var appium_default = {
4028
4029
  },
4029
4030
  "/session/:sessionId/appium/device/system_bars": {
4030
4031
  GET: {
4031
- command: "getSystemBars",
4032
- description: "Retrieve visibility and bounds information of the status and navigation bars.",
4032
+ command: "appiumGetSystemBars",
4033
+ description: "Retrieve visibility and bounds information of the status and navigation bars. This is the raw Appium protocol endpoint. Prefer the `getSystemBars` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4033
4034
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/",
4034
- deprecated: "Use `driver.execute('mobile: getSystemBars')` instead",
4035
+ deprecated: "Use the `getSystemBars` mobile command (`driver.getSystemBars()`) instead",
4035
4036
  parameters: [],
4036
4037
  returns: {
4037
4038
  type: "object[]",
@@ -4069,10 +4070,10 @@ var appium_default = {
4069
4070
  },
4070
4071
  "/session/:sessionId/appium/device/display_density": {
4071
4072
  GET: {
4072
- command: "getDisplayDensity",
4073
- description: "Get display density from device.",
4073
+ command: "appiumGetDisplayDensity",
4074
+ description: "Get display density from device. This is the raw Appium protocol endpoint. Prefer the `getDisplayDensity` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4074
4075
  ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
4075
- deprecated: "Use `driver.execute('mobile: getDisplayDensity')` instead",
4076
+ deprecated: "Use the `getDisplayDensity` mobile command (`driver.getDisplayDensity()`) instead",
4076
4077
  parameters: [],
4077
4078
  returns: {
4078
4079
  type: "*",
@@ -4087,10 +4088,10 @@ var appium_default = {
4087
4088
  },
4088
4089
  "/session/:sessionId/appium/simulator/touch_id": {
4089
4090
  POST: {
4090
- command: "touchId",
4091
+ command: "appiumTouchId",
4091
4092
  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.",
4092
4093
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/",
4093
- deprecated: "Use `driver.execute('mobile: sendBiometricMatch', { ... })` instead",
4094
+ deprecated: "Use the `touchId` mobile command (`driver.touchId()`) instead",
4094
4095
  parameters: [
4095
4096
  {
4096
4097
  name: "match",
@@ -4108,10 +4109,10 @@ var appium_default = {
4108
4109
  },
4109
4110
  "/session/:sessionId/appium/simulator/toggle_touch_id_enrollment": {
4110
4111
  POST: {
4111
- command: "toggleEnrollTouchId",
4112
+ command: "appiumToggleEnrollTouchId",
4112
4113
  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.",
4113
4114
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/",
4114
- deprecated: "Use `driver.execute('mobile: enrollBiometric', { ... })` instead",
4115
+ deprecated: "Use the `toggleEnrollTouchId` mobile command (`driver.toggleEnrollTouchId()`) instead",
4115
4116
  parameters: [
4116
4117
  {
4117
4118
  name: "enabled",
@@ -4130,10 +4131,10 @@ var appium_default = {
4130
4131
  },
4131
4132
  "/session/:sessionId/appium/app/launch": {
4132
4133
  POST: {
4133
- command: "launchApp",
4134
- description: "Launch an app on device.",
4134
+ command: "appiumLaunchApp",
4135
+ description: "Launch an app on device. This is the raw Appium protocol endpoint. Prefer the `launchApp` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4135
4136
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/",
4136
- deprecated: "Use `driver.execute('mobile: launchApp', { ... })` (iOS) or `driver.execute('mobile: activateApp', { ... })` (Android) instead",
4137
+ deprecated: "Use the `launchApp` mobile command (`driver.launchApp()`) instead",
4137
4138
  parameters: [],
4138
4139
  support: {
4139
4140
  ios: {
@@ -4148,10 +4149,10 @@ var appium_default = {
4148
4149
  },
4149
4150
  "/session/:sessionId/appium/app/close": {
4150
4151
  POST: {
4151
- command: "closeApp",
4152
- description: "Close an app on device.",
4152
+ command: "appiumCloseApp",
4153
+ description: "Close an app on device. This is the raw Appium protocol endpoint. Prefer the `closeApp` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4153
4154
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/",
4154
- deprecated: "Use `driver.execute('mobile: terminateApp', { ... })` instead",
4155
+ deprecated: "Use the `closeApp` mobile command (`driver.closeApp()`) instead",
4155
4156
  parameters: [],
4156
4157
  support: {
4157
4158
  ios: {
@@ -4166,10 +4167,10 @@ var appium_default = {
4166
4167
  },
4167
4168
  "/session/:sessionId/appium/app/background": {
4168
4169
  POST: {
4169
- command: "background",
4170
- description: "Send the currently running app for this session to the background.",
4170
+ command: "appiumBackground",
4171
+ description: "Send the currently running app for this session to the background. This is the raw Appium protocol endpoint. Prefer the `background` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4171
4172
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/",
4172
- deprecated: "Use `driver.execute('mobile: backgroundApp', { ... })` instead",
4173
+ deprecated: "Use the `background` mobile command (`driver.background()`) instead",
4173
4174
  parameters: [
4174
4175
  {
4175
4176
  name: "seconds",
@@ -4219,10 +4220,10 @@ var appium_default = {
4219
4220
  },
4220
4221
  "/session/:sessionId/appium/app/strings": {
4221
4222
  POST: {
4222
- command: "getStrings",
4223
- description: "Get app strings.",
4223
+ command: "appiumGetStrings",
4224
+ description: "Get app strings. This is the raw Appium protocol endpoint. Prefer the `getStrings` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4224
4225
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/",
4225
- deprecated: "Use `driver.execute('mobile: getAppStrings', { ... })` instead",
4226
+ deprecated: "Use the `getStrings` mobile command (`driver.getStrings()`) instead",
4226
4227
  parameters: [
4227
4228
  {
4228
4229
  name: "language",
@@ -4387,10 +4388,10 @@ var appium_default = {
4387
4388
  },
4388
4389
  "/session/:sessionId/appium/device/gsm_call": {
4389
4390
  POST: {
4390
- command: "gsmCall",
4391
- description: "Make GSM call (Emulator only).",
4391
+ command: "appiumGsmCall",
4392
+ description: "Make GSM call (Emulator only). This is the raw Appium protocol endpoint. Prefer the `gsmCall` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4392
4393
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/",
4393
- deprecated: "Use `driver.execute('mobile: gsmCall', { ... })` instead",
4394
+ deprecated: "Use the `gsmCall` mobile command (`driver.gsmCall()`) instead",
4394
4395
  parameters: [
4395
4396
  {
4396
4397
  name: "phoneNumber",
@@ -4414,10 +4415,10 @@ var appium_default = {
4414
4415
  },
4415
4416
  "/session/:sessionId/appium/device/gsm_signal": {
4416
4417
  POST: {
4417
- command: "gsmSignal",
4418
- description: "Set GSM signal strength (Emulator only).",
4418
+ command: "appiumGsmSignal",
4419
+ description: "Set GSM signal strength (Emulator only). This is the raw Appium protocol endpoint. Prefer the `gsmSignal` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4419
4420
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/",
4420
- deprecated: "Use `driver.execute('mobile: gsmSignal', { ... })` instead",
4421
+ deprecated: "Use the `gsmSignal` mobile command (`driver.gsmSignal()`) instead",
4421
4422
  parameters: [
4422
4423
  {
4423
4424
  name: "signalStrength",
@@ -4441,10 +4442,10 @@ var appium_default = {
4441
4442
  },
4442
4443
  "/session/:sessionId/appium/device/power_capacity": {
4443
4444
  POST: {
4444
- command: "powerCapacity",
4445
- description: "Set the battery percentage (Emulator only).",
4445
+ command: "appiumPowerCapacity",
4446
+ description: "Set the battery percentage (Emulator only). This is the raw Appium protocol endpoint. Prefer the `powerCapacity` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4446
4447
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/",
4447
- deprecated: "Use `driver.execute('mobile: powerCapacity', { ... })` instead",
4448
+ deprecated: "Use the `powerCapacity` mobile command (`driver.powerCapacity()`) instead",
4448
4449
  parameters: [
4449
4450
  {
4450
4451
  name: "percent",
@@ -4462,10 +4463,10 @@ var appium_default = {
4462
4463
  },
4463
4464
  "/session/:sessionId/appium/device/power_ac": {
4464
4465
  POST: {
4465
- command: "powerAC",
4466
- description: "Set the state of the battery charger to connected or not (Emulator only).",
4466
+ command: "appiumPowerAC",
4467
+ description: "Set the state of the battery charger to connected or not (Emulator only). This is the raw Appium protocol endpoint. Prefer the `powerAC` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4467
4468
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/",
4468
- deprecated: "Use `driver.execute('mobile: powerAC', { ... })` instead",
4469
+ deprecated: "Use the `powerAC` mobile command (`driver.powerAC()`) instead",
4469
4470
  parameters: [
4470
4471
  {
4471
4472
  name: "state",
@@ -4483,10 +4484,10 @@ var appium_default = {
4483
4484
  },
4484
4485
  "/session/:sessionId/appium/device/gsm_voice": {
4485
4486
  POST: {
4486
- command: "gsmVoice",
4487
- description: "Set GSM voice state (Emulator only).",
4487
+ command: "appiumGsmVoice",
4488
+ description: "Set GSM voice state (Emulator only). This is the raw Appium protocol endpoint. Prefer the `gsmVoice` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4488
4489
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/",
4489
- deprecated: "Use `driver.execute('mobile: gsmVoice', { ... })` instead",
4490
+ deprecated: "Use the `gsmVoice` mobile command (`driver.gsmVoice()`) instead",
4490
4491
  parameters: [
4491
4492
  {
4492
4493
  name: "state",
@@ -4504,10 +4505,10 @@ var appium_default = {
4504
4505
  },
4505
4506
  "/session/:sessionId/appium/device/send_sms": {
4506
4507
  POST: {
4507
- command: "sendSms",
4508
- description: "Simulate an SMS message (Emulator only).",
4508
+ command: "appiumSendSms",
4509
+ description: "Simulate an SMS message (Emulator only). This is the raw Appium protocol endpoint. Prefer the `sendSms` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4509
4510
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/",
4510
- deprecated: "Use `driver.execute('mobile: sendSms', { ... })` instead",
4511
+ deprecated: "Use the `sendSms` mobile command (`driver.sendSms()`) instead",
4511
4512
  parameters: [
4512
4513
  {
4513
4514
  name: "phoneNumber",
@@ -4531,10 +4532,10 @@ var appium_default = {
4531
4532
  },
4532
4533
  "/session/:sessionId/appium/device/finger_print": {
4533
4534
  POST: {
4534
- command: "fingerPrint",
4535
- description: "Authenticate users by using their finger print scans on supported emulators.",
4535
+ command: "appiumFingerPrint",
4536
+ description: "Authenticate users by using their finger print scans on supported emulators. This is the raw Appium protocol endpoint. Prefer the `fingerPrint` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4536
4537
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/",
4537
- deprecated: "Use `driver.execute('mobile: fingerPrint', { ... })` instead",
4538
+ deprecated: "Use the `fingerPrint` mobile command (`driver.fingerPrint()`) instead",
4538
4539
  parameters: [
4539
4540
  {
4540
4541
  name: "fingerprintId",
@@ -4552,10 +4553,10 @@ var appium_default = {
4552
4553
  },
4553
4554
  "/session/:sessionId/appium/device/set_clipboard": {
4554
4555
  POST: {
4555
- command: "setClipboard",
4556
- description: "Set the content of the system clipboard",
4556
+ command: "appiumSetClipboard",
4557
+ description: "Set the content of the system clipboard. This is the raw Appium protocol endpoint. Prefer the `setClipboard` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4557
4558
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/",
4558
- deprecated: "Use `driver.execute('mobile: setClipboard', { ... })` instead",
4559
+ deprecated: "Use the `setClipboard` mobile command (`driver.setClipboard()`) instead",
4559
4560
  parameters: [
4560
4561
  {
4561
4562
  name: "content",
@@ -4593,10 +4594,10 @@ var appium_default = {
4593
4594
  },
4594
4595
  "/session/:sessionId/appium/device/get_clipboard": {
4595
4596
  POST: {
4596
- command: "getClipboard",
4597
- description: "Get the content of the system clipboard",
4597
+ command: "appiumGetClipboard",
4598
+ description: "Get the content of the system clipboard. This is the raw Appium protocol endpoint. Prefer the `getClipboard` mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",
4598
4599
  ref: "https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/",
4599
- deprecated: "Use `driver.execute('mobile: getClipboard', { ... })` instead",
4600
+ deprecated: "Use the `getClipboard` mobile command (`driver.getClipboard()`) instead",
4600
4601
  parameters: [
4601
4602
  {
4602
4603
  name: "contentType",
@@ -500,6 +500,7 @@ declare const _default: {
500
500
  POST: {
501
501
  command: string;
502
502
  description: string;
503
+ deprecated: string;
503
504
  ref: string;
504
505
  parameters: {
505
506
  name: string;
@@ -1 +1 @@
1
- {"version":3,"file":"appium.d.ts","sourceRoot":"","sources":["../../src/protocols/appium.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAUA,wBA62EC"}
1
+ {"version":3,"file":"appium.d.ts","sourceRoot":"","sources":["../../src/protocols/appium.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAUA,wBA82EC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wdio/protocols",
3
- "version": "9.24.0",
3
+ "version": "9.26.0",
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",
@@ -29,5 +29,5 @@
29
29
  "publishConfig": {
30
30
  "access": "public"
31
31
  },
32
- "gitHead": "504e648c88b9660ec70fa8247c25e46369768fd9"
32
+ "gitHead": "974fb5ead9fe6738af6f5e2306224036de552f33"
33
33
  }