appium-xcuitest-driver
Version:
Appium driver for iOS using XCUITest for backend
1,546 lines • 249 kB
TypeScript
/**
* @implements {ExternalDriver<XCUITestDriverConstraints, FullContext|string>}
* @extends {BaseDriver<XCUITestDriverConstraints>}
* @privateRemarks **This class should be considered "final"**. It cannot be extended
* due to use of public class field assignments. If extending this class becomes a hard requirement, refer to the implementation of `BaseDriver` on how to do so.
*/
export class XCUITestDriver extends BaseDriver<{
readonly platformName: {
readonly presence: true;
readonly isString: true;
readonly inclusionCaseInsensitive: readonly ["iOS", "tvOS"];
};
readonly browserName: {
readonly isString: true;
};
readonly app: {
readonly isString: true;
};
readonly calendarFormat: {
readonly isString: true;
};
readonly bundleId: {
readonly isString: true;
};
readonly udid: {
readonly isString: true;
};
readonly autoAcceptAlerts: {
readonly isBoolean: true;
};
readonly autoDismissAlerts: {
readonly isBoolean: true;
};
readonly nativeWebTap: {
readonly isBoolean: true;
};
readonly safariInitialUrl: {
readonly isString: true;
};
readonly initialDeeplinkUrl: {
readonly isString: true;
};
readonly safariAllowPopups: {
readonly isBoolean: true;
};
readonly safariIgnoreFraudWarning: {
readonly isBoolean: true;
};
readonly safariOpenLinksInBackground: {
readonly isBoolean: true;
};
readonly safariShowFullResponse: {
readonly isBoolean: true;
};
readonly keepKeyChains: {
readonly isBoolean: true;
};
readonly resetLocationService: {
readonly isBoolean: true;
};
readonly localizableStringsDir: {
readonly isString: true;
};
readonly processArguments: {};
readonly showIOSLog: {
readonly isBoolean: true;
};
readonly webviewConnectRetries: {
readonly isNumber: true;
};
readonly clearSystemFiles: {
readonly isBoolean: true;
};
readonly customSSLCert: {
readonly isString: true;
};
readonly remoteDebugProxy: {
readonly isString: true;
};
readonly enablePerformanceLogging: {
readonly isBoolean: true;
};
readonly enableAsyncExecuteFromHttps: {
readonly isBoolean: true;
};
readonly fullContextList: {
readonly isBoolean: true;
};
readonly ignoreAboutBlankUrl: {
readonly isBoolean: true;
};
readonly skipLogCapture: {
readonly isBoolean: true;
};
readonly deviceName: {
readonly isString: true;
};
readonly showXcodeLog: {
readonly isBoolean: true;
};
readonly wdaLocalPort: {
readonly isNumber: true;
};
readonly wdaRemotePort: {
readonly isNumber: true;
};
readonly wdaBaseUrl: {
readonly isString: true;
};
readonly iosInstallPause: {
readonly isNumber: true;
};
readonly xcodeConfigFile: {
readonly isString: true;
};
readonly xcodeOrgId: {
readonly isString: true;
};
readonly xcodeSigningId: {
readonly isString: true;
};
readonly keychainPath: {
readonly isString: true;
};
readonly keychainPassword: {
readonly isString: true;
};
readonly bootstrapPath: {
readonly isString: true;
};
readonly agentPath: {
readonly isString: true;
};
readonly scaleFactor: {
readonly isString: true;
};
readonly usePrebuiltWDA: {
readonly isBoolean: true;
};
readonly prebuiltWDAPath: {
readonly isString: true;
};
readonly usePreinstalledWDA: {
readonly isBoolean: true;
};
readonly updatedWDABundleIdSuffix: {
readonly isString: true;
};
readonly webDriverAgentUrl: {
readonly isString: true;
};
readonly derivedDataPath: {
readonly isString: true;
};
readonly launchWithIDB: {
readonly isBoolean: true;
};
readonly useNewWDA: {
readonly isBoolean: true;
};
readonly wdaLaunchTimeout: {
readonly isNumber: true;
};
readonly wdaConnectionTimeout: {
readonly isNumber: true;
};
readonly updatedWDABundleId: {
readonly isString: true;
};
readonly resetOnSessionStartOnly: {
readonly isBoolean: true;
};
readonly commandTimeouts: {};
readonly wdaStartupRetries: {
readonly isNumber: true;
};
readonly wdaStartupRetryInterval: {
readonly isNumber: true;
};
readonly prebuildWDA: {
readonly isBoolean: true;
};
readonly connectHardwareKeyboard: {
readonly isBoolean: true;
};
readonly forceTurnOnSoftwareKeyboardSimulator: {
readonly isBoolean: true;
};
readonly simulatorPasteboardAutomaticSync: {
readonly isString: true;
};
readonly simulatorDevicesSetPath: {
readonly isString: true;
};
readonly calendarAccessAuthorized: {
readonly isBoolean: true;
readonly deprecated: true;
};
readonly useSimpleBuildTest: {
readonly isBoolean: true;
readonly deprecated: true;
};
readonly waitForQuiescence: {
readonly isBoolean: true;
readonly deprecated: true;
};
readonly maxTypingFrequency: {
readonly isNumber: true;
};
readonly nativeTyping: {
readonly isBoolean: true;
};
readonly simpleIsVisibleCheck: {
readonly isBoolean: true;
};
readonly shouldUseSingletonTestManager: {
readonly isBoolean: true;
};
readonly isHeadless: {
readonly isBoolean: true;
};
readonly useXctestrunFile: {
readonly isBoolean: true;
};
readonly absoluteWebLocations: {
readonly isBoolean: true;
};
readonly simulatorWindowCenter: {
readonly isString: true;
};
readonly simulatorStartupTimeout: {
readonly isNumber: true;
};
readonly simulatorTracePointer: {
readonly isBoolean: true;
};
readonly useJSONSource: {
readonly isBoolean: true;
};
readonly enforceFreshSimulatorCreation: {
readonly isBoolean: true;
};
readonly shutdownOtherSimulators: {
readonly isBoolean: true;
};
readonly keychainsExcludePatterns: {
readonly isString: true;
};
readonly showSafariConsoleLog: {
readonly isBoolean: true;
};
readonly showSafariNetworkLog: {
readonly isBoolean: true;
};
readonly safariGarbageCollect: {
readonly isBoolean: true;
};
readonly safariGlobalPreferences: {
readonly isObject: true;
};
readonly safariLogAllCommunication: {
readonly isBoolean: true;
};
readonly safariLogAllCommunicationHexDump: {
readonly isBoolean: true;
};
readonly safariSocketChunkSize: {
readonly isNumber: true;
};
readonly mjpegServerPort: {
readonly isNumber: true;
};
readonly reduceMotion: {
readonly isBoolean: true;
};
readonly reduceTransparency: {
readonly isBoolean: true;
};
readonly autoFillPasswords: {
readonly isBoolean: true;
};
readonly mjpegScreenshotUrl: {
readonly isString: true;
};
readonly permissions: {
readonly isString: true;
};
readonly screenshotQuality: {
readonly isNumber: true;
};
readonly wdaEventloopIdleDelay: {
readonly isNumber: true;
};
readonly otherApps: {
readonly isString: true;
};
readonly includeSafariInWebviews: {
readonly isBoolean: true;
};
readonly additionalWebviewBundleIds: {};
readonly webviewConnectTimeout: {
readonly isNumber: true;
};
readonly webviewAtomWaitTimeout: {
readonly isNumber: true;
};
readonly iosSimulatorLogsPredicate: {
readonly isString: true;
};
readonly simulatorLogLevel: {
readonly isString: true;
};
readonly appPushTimeout: {
readonly isNumber: true;
};
readonly nativeWebTapStrict: {
readonly isBoolean: true;
};
readonly safariWebInspectorMaxFrameLength: {
readonly isNumber: true;
};
readonly allowProvisioningDeviceRegistration: {
readonly isBoolean: true;
};
readonly waitForIdleTimeout: {
readonly isNumber: true;
};
readonly resultBundlePath: {
readonly isString: true;
};
readonly resultBundleVersion: {
readonly isNumber: true;
};
readonly safariIgnoreWebHostnames: {
readonly isString: true;
};
readonly disableAutomaticScreenshots: {
readonly isBoolean: true;
};
readonly shouldTerminateApp: {
readonly isBoolean: true;
};
readonly forceAppLaunch: {
readonly isBoolean: true;
};
readonly useNativeCachingStrategy: {
readonly isBoolean: true;
};
readonly appInstallStrategy: {
readonly deprecated: true;
readonly isString: true;
readonly inclusionCaseInsensitive: readonly ["serial", "parallel", "ios-deploy"];
};
readonly enforceAppInstall: {
readonly isBoolean: true;
};
readonly skipTriggerInputEventAfterSendkeys: {
readonly isBoolean: true;
};
readonly sendKeyStrategy: {
readonly isString: true;
};
readonly skipSyncUiDialogTranslation: {
readonly isBoolean: true;
};
readonly forceSimulatorSoftwareKeyboardPresence: {
readonly isBoolean: true;
};
readonly appLaunchStateTimeoutSec: {
readonly isNumber: true;
};
readonly appTimeZone: {
readonly isString: true;
};
readonly pageLoadStrategy: {
readonly isString: true;
readonly inclusionCaseInsensitive: readonly ["none", "eager", "normal"];
};
}, import("@appium/types").StringRecord, import("@appium/types").StringRecord, import("@appium/types").DefaultCreateSessionResult<{
readonly platformName: {
readonly presence: true;
readonly isString: true;
readonly inclusionCaseInsensitive: readonly ["iOS", "tvOS"];
};
readonly browserName: {
readonly isString: true;
};
readonly app: {
readonly isString: true;
};
readonly calendarFormat: {
readonly isString: true;
};
readonly bundleId: {
readonly isString: true;
};
readonly udid: {
readonly isString: true;
};
readonly autoAcceptAlerts: {
readonly isBoolean: true;
};
readonly autoDismissAlerts: {
readonly isBoolean: true;
};
readonly nativeWebTap: {
readonly isBoolean: true;
};
readonly safariInitialUrl: {
readonly isString: true;
};
readonly initialDeeplinkUrl: {
readonly isString: true;
};
readonly safariAllowPopups: {
readonly isBoolean: true;
};
readonly safariIgnoreFraudWarning: {
readonly isBoolean: true;
};
readonly safariOpenLinksInBackground: {
readonly isBoolean: true;
};
readonly safariShowFullResponse: {
readonly isBoolean: true;
};
readonly keepKeyChains: {
readonly isBoolean: true;
};
readonly resetLocationService: {
readonly isBoolean: true;
};
readonly localizableStringsDir: {
readonly isString: true;
};
readonly processArguments: {};
readonly showIOSLog: {
readonly isBoolean: true;
};
readonly webviewConnectRetries: {
readonly isNumber: true;
};
readonly clearSystemFiles: {
readonly isBoolean: true;
};
readonly customSSLCert: {
readonly isString: true;
};
readonly remoteDebugProxy: {
readonly isString: true;
};
readonly enablePerformanceLogging: {
readonly isBoolean: true;
};
readonly enableAsyncExecuteFromHttps: {
readonly isBoolean: true;
};
readonly fullContextList: {
readonly isBoolean: true;
};
readonly ignoreAboutBlankUrl: {
readonly isBoolean: true;
};
readonly skipLogCapture: {
readonly isBoolean: true;
};
readonly deviceName: {
readonly isString: true;
};
readonly showXcodeLog: {
readonly isBoolean: true;
};
readonly wdaLocalPort: {
readonly isNumber: true;
};
readonly wdaRemotePort: {
readonly isNumber: true;
};
readonly wdaBaseUrl: {
readonly isString: true;
};
readonly iosInstallPause: {
readonly isNumber: true;
};
readonly xcodeConfigFile: {
readonly isString: true;
};
readonly xcodeOrgId: {
readonly isString: true;
};
readonly xcodeSigningId: {
readonly isString: true;
};
readonly keychainPath: {
readonly isString: true;
};
readonly keychainPassword: {
readonly isString: true;
};
readonly bootstrapPath: {
readonly isString: true;
};
readonly agentPath: {
readonly isString: true;
};
readonly scaleFactor: {
readonly isString: true;
};
readonly usePrebuiltWDA: {
readonly isBoolean: true;
};
readonly prebuiltWDAPath: {
readonly isString: true;
};
readonly usePreinstalledWDA: {
readonly isBoolean: true;
};
readonly updatedWDABundleIdSuffix: {
readonly isString: true;
};
readonly webDriverAgentUrl: {
readonly isString: true;
};
readonly derivedDataPath: {
readonly isString: true;
};
readonly launchWithIDB: {
readonly isBoolean: true;
};
readonly useNewWDA: {
readonly isBoolean: true;
};
readonly wdaLaunchTimeout: {
readonly isNumber: true;
};
readonly wdaConnectionTimeout: {
readonly isNumber: true;
};
readonly updatedWDABundleId: {
readonly isString: true;
};
readonly resetOnSessionStartOnly: {
readonly isBoolean: true;
};
readonly commandTimeouts: {};
readonly wdaStartupRetries: {
readonly isNumber: true;
};
readonly wdaStartupRetryInterval: {
readonly isNumber: true;
};
readonly prebuildWDA: {
readonly isBoolean: true;
};
readonly connectHardwareKeyboard: {
readonly isBoolean: true;
};
readonly forceTurnOnSoftwareKeyboardSimulator: {
readonly isBoolean: true;
};
readonly simulatorPasteboardAutomaticSync: {
readonly isString: true;
};
readonly simulatorDevicesSetPath: {
readonly isString: true;
};
readonly calendarAccessAuthorized: {
readonly isBoolean: true;
readonly deprecated: true;
};
readonly useSimpleBuildTest: {
readonly isBoolean: true;
readonly deprecated: true;
};
readonly waitForQuiescence: {
readonly isBoolean: true;
readonly deprecated: true;
};
readonly maxTypingFrequency: {
readonly isNumber: true;
};
readonly nativeTyping: {
readonly isBoolean: true;
};
readonly simpleIsVisibleCheck: {
readonly isBoolean: true;
};
readonly shouldUseSingletonTestManager: {
readonly isBoolean: true;
};
readonly isHeadless: {
readonly isBoolean: true;
};
readonly useXctestrunFile: {
readonly isBoolean: true;
};
readonly absoluteWebLocations: {
readonly isBoolean: true;
};
readonly simulatorWindowCenter: {
readonly isString: true;
};
readonly simulatorStartupTimeout: {
readonly isNumber: true;
};
readonly simulatorTracePointer: {
readonly isBoolean: true;
};
readonly useJSONSource: {
readonly isBoolean: true;
};
readonly enforceFreshSimulatorCreation: {
readonly isBoolean: true;
};
readonly shutdownOtherSimulators: {
readonly isBoolean: true;
};
readonly keychainsExcludePatterns: {
readonly isString: true;
};
readonly showSafariConsoleLog: {
readonly isBoolean: true;
};
readonly showSafariNetworkLog: {
readonly isBoolean: true;
};
readonly safariGarbageCollect: {
readonly isBoolean: true;
};
readonly safariGlobalPreferences: {
readonly isObject: true;
};
readonly safariLogAllCommunication: {
readonly isBoolean: true;
};
readonly safariLogAllCommunicationHexDump: {
readonly isBoolean: true;
};
readonly safariSocketChunkSize: {
readonly isNumber: true;
};
readonly mjpegServerPort: {
readonly isNumber: true;
};
readonly reduceMotion: {
readonly isBoolean: true;
};
readonly reduceTransparency: {
readonly isBoolean: true;
};
readonly autoFillPasswords: {
readonly isBoolean: true;
};
readonly mjpegScreenshotUrl: {
readonly isString: true;
};
readonly permissions: {
readonly isString: true;
};
readonly screenshotQuality: {
readonly isNumber: true;
};
readonly wdaEventloopIdleDelay: {
readonly isNumber: true;
};
readonly otherApps: {
readonly isString: true;
};
readonly includeSafariInWebviews: {
readonly isBoolean: true;
};
readonly additionalWebviewBundleIds: {};
readonly webviewConnectTimeout: {
readonly isNumber: true;
};
readonly webviewAtomWaitTimeout: {
readonly isNumber: true;
};
readonly iosSimulatorLogsPredicate: {
readonly isString: true;
};
readonly simulatorLogLevel: {
readonly isString: true;
};
readonly appPushTimeout: {
readonly isNumber: true;
};
readonly nativeWebTapStrict: {
readonly isBoolean: true;
};
readonly safariWebInspectorMaxFrameLength: {
readonly isNumber: true;
};
readonly allowProvisioningDeviceRegistration: {
readonly isBoolean: true;
};
readonly waitForIdleTimeout: {
readonly isNumber: true;
};
readonly resultBundlePath: {
readonly isString: true;
};
readonly resultBundleVersion: {
readonly isNumber: true;
};
readonly safariIgnoreWebHostnames: {
readonly isString: true;
};
readonly disableAutomaticScreenshots: {
readonly isBoolean: true;
};
readonly shouldTerminateApp: {
readonly isBoolean: true;
};
readonly forceAppLaunch: {
readonly isBoolean: true;
};
readonly useNativeCachingStrategy: {
readonly isBoolean: true;
};
readonly appInstallStrategy: {
readonly deprecated: true;
readonly isString: true;
readonly inclusionCaseInsensitive: readonly ["serial", "parallel", "ios-deploy"];
};
readonly enforceAppInstall: {
readonly isBoolean: true;
};
readonly skipTriggerInputEventAfterSendkeys: {
readonly isBoolean: true;
};
readonly sendKeyStrategy: {
readonly isString: true;
};
readonly skipSyncUiDialogTranslation: {
readonly isBoolean: true;
};
readonly forceSimulatorSoftwareKeyboardPresence: {
readonly isBoolean: true;
};
readonly appLaunchStateTimeoutSec: {
readonly isNumber: true;
};
readonly appTimeZone: {
readonly isString: true;
};
readonly pageLoadStrategy: {
readonly isString: true;
readonly inclusionCaseInsensitive: readonly ["none", "eager", "normal"];
};
}>, void, import("@appium/types").StringRecord> implements ExternalDriver<XCUITestDriverConstraints, FullContext | string> {
static newMethodMap: {
readonly '/session/:sessionId/timeouts/async_script': {
readonly POST: {
readonly command: "asyncScriptTimeout";
readonly payloadParams: {
readonly required: readonly ["ms"];
};
};
};
readonly '/session/:sessionId/timeouts/implicit_wait': {
readonly POST: {
readonly command: "implicitWait";
readonly payloadParams: {
readonly required: readonly ["ms"];
};
};
};
readonly '/session/:sessionId/window/:windowhandle/size': {
readonly GET: {
readonly command: "getWindowSize";
};
};
readonly '/session/:sessionId/element/:elementId/submit': {
readonly POST: {
readonly command: "submit";
};
};
readonly '/session/:sessionId/keys': {
readonly POST: {
readonly command: "keys";
readonly payloadParams: {
readonly required: readonly ["value"];
};
};
};
readonly '/session/:sessionId/element/:elementId/location': {
readonly GET: {
readonly command: "getLocation";
};
};
readonly '/session/:sessionId/element/:elementId/location_in_view': {
readonly GET: {
readonly command: "getLocationInView";
};
};
readonly '/session/:sessionId/element/:elementId/size': {
readonly GET: {
readonly command: "getSize";
};
};
readonly '/session/:sessionId/appium/device/shake': {
readonly POST: {
readonly command: "mobileShake";
};
};
readonly '/session/:sessionId/appium/device/lock': {
readonly POST: {
readonly command: "lock";
readonly payloadParams: {
readonly optional: readonly ["seconds"];
};
};
};
readonly '/session/:sessionId/appium/device/unlock': {
readonly POST: {
readonly command: "unlock";
};
};
readonly '/session/:sessionId/appium/device/is_locked': {
readonly POST: {
readonly command: "isLocked";
};
};
readonly '/session/:sessionId/appium/start_recording_screen': {
readonly POST: {
readonly command: "startRecordingScreen";
readonly payloadParams: {
readonly optional: readonly ["options"];
};
};
};
readonly '/session/:sessionId/appium/stop_recording_screen': {
readonly POST: {
readonly command: "stopRecordingScreen";
readonly payloadParams: {
readonly optional: readonly ["options"];
};
};
};
readonly '/session/:sessionId/appium/device/app_state': {
readonly POST: {
readonly command: "queryAppState";
readonly payloadParams: {
readonly required: readonly [readonly ["appId"], readonly ["bundleId"]];
};
};
};
readonly '/session/:sessionId/appium/simulator/touch_id': {
readonly POST: {
readonly command: "touchId";
readonly payloadParams: {
readonly required: readonly ["match"];
};
};
};
readonly '/session/:sessionId/appium/simulator/toggle_touch_id_enrollment': {
readonly POST: {
readonly command: "toggleEnrollTouchId";
readonly payloadParams: {
readonly optional: readonly ["enabled"];
};
};
};
readonly '/session/:sessionId/appium/app/launch': {
readonly POST: {
readonly command: "launchApp";
};
};
readonly '/session/:sessionId/appium/app/close': {
readonly POST: {
readonly command: "closeApp";
};
};
readonly '/session/:sessionId/appium/app/reset': {
readonly POST: {
readonly command: "reset";
};
};
readonly '/session/:sessionId/appium/app/background': {
readonly POST: {
readonly command: "background";
readonly payloadParams: {
readonly required: readonly ["seconds"];
};
};
};
readonly '/session/:sessionId/appium/app/strings': {
readonly POST: {
readonly command: "getStrings";
readonly payloadParams: {
readonly optional: readonly ["language", "stringFile"];
};
};
};
readonly '/session/:sessionId/appium/element/:elementId/value': {
readonly POST: {
readonly command: "setValueImmediate";
readonly payloadParams: {
readonly required: readonly ["text"];
};
};
};
readonly '/session/:sessionId/appium/receive_async_response': {
readonly POST: {
readonly command: "receiveAsyncResponse";
readonly payloadParams: {
readonly required: readonly ["response"];
};
};
};
readonly '/session/:sessionId/appium/device/get_clipboard': {
readonly POST: {
readonly command: "getClipboard";
readonly payloadParams: {
readonly optional: readonly ["contentType"];
};
};
};
readonly '/session/:sessionId/appium/device/set_clipboard': {
readonly POST: {
readonly command: "setClipboard";
readonly payloadParams: {
readonly required: readonly ["content"];
readonly optional: readonly ["contentType", "label"];
};
};
};
};
static executeMethodMap: {
readonly 'mobile: tap': {
readonly command: "mobileTap";
readonly params: {
readonly required: readonly ["x", "y"];
readonly optional: readonly ["elementId"];
};
};
readonly 'mobile: scroll': {
readonly command: "mobileScroll";
readonly params: {
readonly optional: readonly ["name", "direction", "predicateString", "toVisible", "distance", "elementId"];
};
};
readonly 'mobile: selectPickerWheelValue': {
readonly command: "mobileSelectPickerWheelValue";
readonly params: {
readonly required: readonly ["elementId", "order"];
readonly optional: readonly ["offset"];
};
};
readonly 'mobile: sendMemoryWarning': {
readonly command: "mobileSendMemoryWarning";
readonly params: {
readonly required: readonly ["bundleId"];
};
};
readonly 'mobile: swipe': {
readonly command: "mobileSwipe";
readonly params: {
readonly required: readonly ["direction"];
readonly optional: readonly ["velocity", "elementId"];
};
};
readonly 'mobile: pinch': {
readonly command: "mobilePinch";
readonly params: {
readonly required: readonly ["scale", "velocity"];
readonly optional: readonly ["elementId"];
};
};
readonly 'mobile: doubleTap': {
readonly command: "mobileDoubleTap";
readonly params: {
readonly optional: readonly ["elementId", "x", "y"];
};
};
readonly 'mobile: twoFingerTap': {
readonly command: "mobileTwoFingerTap";
readonly params: {
readonly optional: readonly ["elementId"];
};
};
readonly 'mobile: tapWithNumberOfTaps': {
readonly command: "mobileTapWithNumberOfTaps";
readonly params: {
readonly optional: readonly ["numberOfTouches", "numberOfTaps", "elementId"];
};
};
readonly 'mobile: touchAndHold': {
readonly command: "mobileTouchAndHold";
readonly params: {
readonly required: readonly ["duration"];
readonly optional: readonly ["x", "y", "elementId"];
};
};
readonly 'mobile: dragFromToForDuration': {
readonly command: "mobileDragFromToForDuration";
readonly params: {
readonly required: readonly ["duration", "fromX", "fromY", "toX", "toY"];
readonly optional: readonly ["elementId"];
};
};
readonly 'mobile: rotateElement': {
readonly command: "mobileRotateElement";
readonly params: {
readonly required: readonly ["rotation", "velocity"];
readonly optional: readonly ["elementId"];
};
};
readonly 'mobile: dragFromToWithVelocity': {
readonly command: "mobileDragFromToWithVelocity";
readonly params: {
readonly required: readonly ["pressDuration", "holdDuration", "velocity"];
readonly optional: readonly ["fromElementId", "toElementId", "fromX", "fromY", "toX", "toY"];
};
};
readonly 'mobile: forcePress': {
readonly command: "mobileForcePress";
readonly params: {
readonly optional: readonly ["x", "y", "duration", "pressure", "elementId"];
};
};
readonly 'mobile: scrollToElement': {
readonly command: "mobileScrollToElement";
readonly params: {
readonly required: readonly ["elementId"];
};
};
readonly 'mobile: alert': {
readonly command: "mobileHandleAlert";
readonly params: {
readonly required: readonly ["action"];
readonly optional: readonly ["buttonLabel"];
};
};
readonly 'mobile: setPasteboard': {
readonly command: "mobileSetPasteboard";
readonly params: {
readonly required: readonly ["content"];
readonly optional: readonly ["encoding"];
};
};
readonly 'mobile: getPasteboard': {
readonly command: "mobileGetPasteboard";
readonly params: {
readonly optional: readonly ["encoding"];
};
};
readonly 'mobile: source': {
readonly command: "mobileGetSource";
readonly params: {
readonly optional: readonly ["format", "excludedAttributes"];
};
};
readonly 'mobile: getAppStrings': {
readonly command: "getStrings";
readonly params: {
readonly optional: readonly ["language", "stringFile"];
};
};
readonly 'mobile: getContexts': {
readonly command: "mobileGetContexts";
readonly params: {
readonly optional: readonly ["waitForWebviewMs"];
};
};
readonly 'mobile: installApp': {
readonly command: "mobileInstallApp";
readonly params: {
readonly required: readonly ["app"];
readonly optional: readonly ["timeoutMs", "checkVersion"];
};
};
readonly 'mobile: isAppInstalled': {
readonly command: "mobileIsAppInstalled";
readonly params: {
readonly required: readonly ["bundleId"];
};
};
readonly 'mobile: removeApp': {
readonly command: "mobileRemoveApp";
readonly params: {
readonly required: readonly ["bundleId"];
};
};
readonly 'mobile: launchApp': {
readonly command: "mobileLaunchApp";
readonly params: {
readonly required: readonly ["bundleId"];
readonly optional: readonly ["arguments", "environment"];
};
};
readonly 'mobile: terminateApp': {
readonly command: "mobileTerminateApp";
readonly params: {
readonly required: readonly ["bundleId"];
};
};
readonly 'mobile: killApp': {
readonly command: "mobileKillApp";
readonly params: {
readonly required: readonly ["bundleId"];
};
};
readonly 'mobile: queryAppState': {
readonly command: "mobileQueryAppState";
readonly params: {
readonly required: readonly ["bundleId"];
};
};
readonly 'mobile: activateApp': {
readonly command: "mobileActivateApp";
readonly params: {
readonly required: readonly ["bundleId"];
};
};
readonly 'mobile: listApps': {
readonly command: "mobileListApps";
readonly params: {
readonly optional: readonly ["applicationType"];
};
};
readonly 'mobile: clearApp': {
readonly command: "mobileClearApp";
readonly params: {
readonly required: readonly ["bundleId"];
};
};
readonly 'mobile: viewportScreenshot': {
readonly command: "getViewportScreenshot";
};
readonly 'mobile: viewportRect': {
readonly command: "getViewportRect";
};
readonly 'mobile: startPerfRecord': {
readonly command: "mobileStartPerfRecord";
readonly params: {
readonly optional: readonly ["timeout", "profileName", "pid"];
};
};
readonly 'mobile: stopPerfRecord': {
readonly command: "mobileStopPerfRecord";
readonly params: {
readonly optional: readonly ["remotePath", "user", "pass", "method", "profileName", "headers", "fileFieldName", "formFields"];
};
};
readonly 'mobile: installCertificate': {
readonly command: "mobileInstallCertificate";
readonly params: {
readonly required: readonly ["content"];
readonly optional: readonly ["commonName", "isRoot"];
};
};
readonly 'mobile: removeCertificate': {
readonly command: "mobileRemoveCertificate";
readonly params: {
readonly required: readonly ["name"];
};
};
readonly 'mobile: listCertificates': {
readonly command: "mobileListCertificates";
};
readonly 'mobile: startLogsBroadcast': {
readonly command: "mobileStartLogsBroadcast";
};
readonly 'mobile: stopLogsBroadcast': {
readonly command: "mobileStopLogsBroadcast";
};
readonly 'mobile: batteryInfo': {
readonly command: "mobileGetBatteryInfo";
};
readonly 'mobile: performAccessibilityAudit': {
readonly command: "mobilePerformAccessibilityAudit";
readonly params: {
readonly optional: readonly ["auditTypes"];
};
};
readonly 'mobile: deviceInfo': {
readonly command: "mobileGetDeviceInfo";
};
readonly 'mobile: getDeviceTime': {
readonly command: "mobileGetDeviceTime";
readonly params: {
readonly optional: readonly ["format"];
};
};
readonly 'mobile: activeAppInfo': {
readonly command: "mobileGetActiveAppInfo";
};
readonly 'mobile: deviceScreenInfo': {
readonly command: "getScreenInfo";
};
readonly 'mobile: pressButton': {
readonly command: "mobilePressButton";
readonly params: {
readonly required: readonly ["name"];
readonly optional: readonly ["durationSeconds"];
};
};
readonly 'mobile: enrollBiometric': {
readonly command: "mobileEnrollBiometric";
readonly params: {
readonly optional: readonly ["isEnabled"];
};
};
readonly 'mobile: sendBiometricMatch': {
readonly command: "mobileSendBiometricMatch";
readonly params: {
readonly optional: readonly ["type", "match"];
};
};
readonly 'mobile: isBiometricEnrolled': {
readonly command: "mobileIsBiometricEnrolled";
};
readonly 'mobile: clearKeychains': {
readonly command: "mobileClearKeychains";
};
readonly 'mobile: getPermission': {
readonly command: "mobileGetPermission";
readonly params: {
readonly required: readonly ["bundleId", "service"];
};
};
readonly 'mobile: setPermission': {
readonly command: "mobileSetPermissions";
readonly params: {
readonly required: readonly ["access", "bundleId"];
};
};
readonly 'mobile: resetPermission': {
readonly command: "mobileResetPermission";
readonly params: {
readonly required: readonly ["service"];
};
};
readonly 'mobile: getAppearance': {
readonly command: "mobileGetAppearance";
};
readonly 'mobile: setAppearance': {
readonly command: "mobileSetAppearance";
readonly params: {
readonly required: readonly ["style"];
};
};
readonly 'mobile: getIncreaseContrast': {
readonly command: "mobileGetIncreaseContrast";
};
readonly 'mobile: setIncreaseContrast': {
readonly command: "mobileSetIncreaseContrast";
readonly params: {
readonly required: readonly ["increaseContrast"];
};
};
readonly 'mobile: contentSize': {
readonly command: "mobileGetContentSize";
};
readonly 'mobile: setContentSize': {
readonly command: "mobileSetContentSize";
readonly params: {
readonly required: readonly ["size"];
};
};
readonly 'mobile: getClipboard': {
readonly command: "getClipboard";
readonly params: {
readonly optional: readonly ["contentType"];
};
};
readonly 'mobile: setClipboard': {
readonly command: "setClipboard";
readonly params: {
readonly required: readonly ["content"];
readonly optional: readonly ["contentType"];
};
};
readonly 'mobile: siriCommand': {
readonly command: "mobileSiriCommand";
readonly params: {
readonly required: readonly ["text"];
};
};
readonly 'mobile: pushFile': {
readonly command: "mobilePushFile";
readonly params: {
readonly required: readonly ["remotePath", "payload"];
};
};
readonly 'mobile: pullFile': {
readonly command: "mobilePullFile";
readonly params: {
readonly required: readonly ["remotePath"];
};
};
readonly 'mobile: pullFolder': {
readonly command: "mobilePullFolder";
readonly params: {
readonly required: readonly ["remotePath"];
};
};
readonly 'mobile: deleteFile': {
readonly command: "mobileDeleteFile";
readonly params: {
readonly required: readonly ["remotePath"];
};
};
readonly 'mobile: deleteFolder': {
readonly command: "mobileDeleteFolder";
readonly params: {
readonly required: readonly ["remotePath"];
};
};
readonly 'mobile: runXCTest': {
readonly command: "mobileRunXCTest";
readonly params: {
readonly required: readonly ["testRunnerBundleId", "appUnderTestBundleId", "xctestBundleId"];
readonly optional: readonly ["args", "testType", "env", "timeout"];
};
};
readonly 'mobile: installXCTestBundle': {
readonly command: "mobileInstallXCTestBundle";
readonly params: {
readonly required: readonly ["xctestApp"];
};
};
readonly 'mobile: listXCTestBundles': {
readonly command: "mobileListXCTestBundles";
};
readonly 'mobile: listXCTestsInTestBundle': {
readonly command: "mobileListXCTestsInTestBundle";
readonly params: {
readonly required: readonly ["bundle"];
};
};
readonly 'mobile: startXCTestScreenRecording': {
readonly command: "mobileStartXctestScreenRecording";
readonly params: {
readonly optional: readonly ["fps", "codec"];
};
};
readonly 'mobile: getXCTestScreenRecordingInfo': {
readonly command: "mobileGetXctestScreenRecordingInfo";
};
readonly 'mobile: stopXCTestScreenRecording': {
readonly command: "mobileStopXctestScreenRecording";
readonly params: {
readonly optional: readonly ["remotePath", "user", "pass", "headers", "fileFieldName", "formFields", "method"];
};
};
readonly 'mobile: pushNotification': {
readonly command: "mobilePushNotification";
readonly params: {
readonly required: readonly ["bundleId", "payload"];
};
};
readonly 'mobile: expectNotification': {
readonly command: "mobileExpectNotification";
readonly params: {
readonly required: readonly ["name"];
readonly optional: readonly ["type", "timeoutSeconds"];
};
};
readonly 'mobile: performIoHidEvent': {
readonly command: "mobilePerformIoHidEvent";
readonly params: {
readonly required: readonly ["page", "usage", "durationSeconds"];
};
};
readonly 'mobile: configureLocalization': {
readonly command: "mobileConfigureLocalization";
readonly params: {
readonly optional: readonly ["keyboard", "language", "locale"];
};
};
readonly 'mobile: resetLocationService': {
readonly command: "mobileResetLocationService";
};
readonly 'mobile: startPcap': {
readonly command: "mobileStartPcap";
readonly params: {
readonly optional: readonly ["timeLimitSec", "forceRestart"];
};
};
readonly 'mobile: stopPcap': {
readonly command: "mobileStopPcap";
};
readonly 'mobile: listConditionInducers': {
readonly command: "listConditionInducers";
};
readonly 'mobile: enableConditionInducer': {
readonly command: "enableConditionInducer";
readonly params: {
readonly required: readonly ["conditionID", "profileID"];
};
};
readonly 'mobile: disableConditionInducer': {
readonly command: "disableConditionInducer";
};
readonly 'mobile: updateSafariPreferences': {
readonly command: "mobileUpdateSafariPreferences";
readonly params: {
readonly required: readonly ["preferences"];
};
};
readonly 'mobile: calibrateWebToRealCoordinatesTranslation': {
readonly command: "mobileCalibrateWebToRealCoordinatesTranslation";
};
readonly 'mobile: keys': {
readonly command: "mobileKeys";
readonly params: {
readonly required: readonly ["keys"];
readonly optional: readonly ["elementId"];
};
};
readonly 'mobile: deepLink': {
readonly command: "mobileDeepLink";
readonly params: {
readonly required: readonly ["url"];
readonly optional: readonly ["bundleId"];
};
};
readonly 'mobile: setSimulatedLocation': {
readonly command: "mobileSetSimulatedLocation";
readonly params: {
readonly required: readonly ["latitude", "longitude"];
};
};
readonly 'mobile: getSimulatedLocation': {
readonly command: "mobileGetSimulatedLocation";
};
readonly 'mobile: resetSimulatedLocation': {
readonly command: "mobileResetSimulatedLocation";
};
readonly 'mobile: shake': {
readonly command: "mobileShake";
};
readonly 'mobile: startAudioRecording': {
readonly command: "startAudioRecording";
readonly params: {
readonly required: readonly ["audioInput"];
readonly optional: readonly ["timeLimit", "audioCodec", "audioBitrate", "audioChannels", "audioRate", "forceRestart"];
};
};
readonly 'mobile: stopAudioRecording': {
readonly command: "stopAudioRecording";
};
readonly 'mobile: hideKeyboard': {
readonly command: "mobileHideKeyboard";
readonly params: {
readonly optional: readonly ["keys"];
};
};
readonly 'mobile: isKeyboardShown': {
readonly command: "isKeyboardShown";
};
readonly 'mobile: lock': {
readonly command: "lock";
readonly params: {
readonly optional: readonly ["seconds"];
};
};
readonly 'mobile: unlock': {
readonly command: "unlock";
};
readonly 'mobile: isLocked': {
readonly command: "isLocked";
};
readonly 'mobile: backgroundApp': {
readonly command: "background";
readonly params: {
readonly optional: readonly ["seconds"];
};
};
readonly 'mobile: simctl': {
readonly command: "mobileSimctl";
readonly params: {
readonly required: readonly ["command"];
readonly optional: readonly ["args", "timeout"];
};
};
};
/**
*
* @param {XCUITestDriverOpts} opts
* @param {boolean} shouldValidateCaps
*/
constructor(opts?: XCUITestDriverOpts, shouldValidateCaps?: boolean);
/** @type {string|null|undefined} */
curWindowHandle: string | null | undefined;
/**
* @type {boolean|undefined}
*/
selectingNewPage: boolean | undefined;
/** @type {string[]} */
contexts: string[];
/** @type {string|null} */
curContext: string | null;
/** @type {string[]} */
curWebFrames: string[];
/** @type {import('./types').CalibrationData|null} */
webviewCalibrationResult: import("./types").CalibrationData | null;
/**
* @type {import('./types').Page[]|undefined}
*/
windowHandleCache: import("./types").Page[] | undefined;
/** @type {import('./types').AsyncPromise|undefined} */
asyncPromise: import("./types").AsyncPromise | undefined;
/** @type {number|undefined} */
asyncWaitMs: number | undefined;
/** @type {((logRecord: {message: string}) => void)|null} */
_syslogWebsocketListener: ((logRecord: {
message: string;
}) => void) | null;
/** @type {import('./commands/performance').PerfRecorder[]} */
_perfRecorders: import("./commands/performance").PerfRecorder[];
/** @type {LRUCache} */
webElementsCache: LRUCache<any, any, any>;
/**
* @type {any|null}
* @privateRemarks needs types
**/
_conditionInducerService: any | null;
/** @type {boolean|undefined} */
_isSafariIphone: boolean | undefined;
/** @type {boolean|undefined} */
_isSafariNotched: boolean | undefined;
/** @type {import('./commands/types').WaitingAtoms} */
_waitingAtoms: import("./commands/types").WaitingAtoms;
/** @type {import('./types').LifecycleData} */
lifecycleData: import("./types").LifecycleData;
/** @type {import('./commands/record-audio').AudioRecorder|null} */
_audioRecorder: import("./commands/record-audio").AudioRecorder | null;
/** @type {XcodeVersion|undefined} */
xcodeVersion: XcodeVersion | undefined;
/** @type {import('./commands/pcap').TrafficCapture|null} */
_trafficCapture: import("./commands/pcap").TrafficCapture | null;
/** @type {Simulator|RealDevice} */
_device: Simulator | RealDevice;
/** @type {string|null} */
_iosSdkVersion: string | null;
/** @type {WebDriverAgent} */
wda: WebDriverAgent;
/** @type {import('appium-remote-debugger').RemoteDebugger|null} */
remote: import("appium-remote-debugger").RemoteDebugger | null;
/** @type {DriverLogs} */
logs: DriverLogs;
/** @type {