@deque/axe-appium3-webdriveragent 0.0.0-stage → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Configurations/IOSSettings.xcconfig +31 -0
- package/Configurations/IOSTestSettings.xcconfig +1 -0
- package/Configurations/TVOSSettings.xcconfig +31 -0
- package/Configurations/TVOSTestSettings.xcconfig +1 -0
- package/LICENSE +66 -0
- package/LICENSE-3RD-PARTY.md +70 -0
- package/MySwiftFramework/JSONHelper.swift +31 -0
- package/MySwiftFramework/MySwiftFramework.h +18 -0
- package/PrivateHeaders/AccessibilityUtilities/AXSettings.h +15 -0
- package/PrivateHeaders/MobileCoreServices/LSApplicationWorkspace.h +127 -0
- package/PrivateHeaders/TextInput/TIPreferencesController.h +45 -0
- package/PrivateHeaders/UIKitCore/UIKeyboardImpl.h +27 -0
- package/PrivateHeaders/XCTest/CDStructures.h +7 -0
- package/PrivateHeaders/XCTest/NSFastEnumeration-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCAXClient_iOS.h +91 -0
- package/PrivateHeaders/XCTest/XCApplicationQuery.h +30 -0
- package/PrivateHeaders/XCTest/XCDebugLogDelegate-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCPointerEvent.h +63 -0
- package/PrivateHeaders/XCTest/XCPointerEventPath.h +65 -0
- package/PrivateHeaders/XCTest/XCSynthesizedEventRecord.h +55 -0
- package/PrivateHeaders/XCTest/XCTAggregateSuiteRunStatistics.h +38 -0
- package/PrivateHeaders/XCTest/XCTAttachmentManager.h +33 -0
- package/PrivateHeaders/XCTest/XCTCapabilities.h +35 -0
- package/PrivateHeaders/XCTest/XCTCapabilitiesProviding-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTElementSetTransformer-Protocol.h +35 -0
- package/PrivateHeaders/XCTest/XCTElementSnapshotAttributeDataSource-Protocol.h +33 -0
- package/PrivateHeaders/XCTest/XCTElementSnapshotProvider-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTExpectedFailureContextManager.h +35 -0
- package/PrivateHeaders/XCTest/XCTFuture.h +45 -0
- package/PrivateHeaders/XCTest/XCTHarnessEventReporting-Protocol.h +29 -0
- package/PrivateHeaders/XCTest/XCTIssue.h +49 -0
- package/PrivateHeaders/XCTest/XCTIssueHandling-Protocol.h +26 -0
- package/PrivateHeaders/XCTest/XCTMacCatalystStatusProviding-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTMeasureOptions.h +48 -0
- package/PrivateHeaders/XCTest/XCTMemoryChecker.h +50 -0
- package/PrivateHeaders/XCTest/XCTMemoryCheckerDelegate-Protocol.h +26 -0
- package/PrivateHeaders/XCTest/XCTMessagingChannel_IDEToRunner-Protocol.h +27 -0
- package/PrivateHeaders/XCTest/XCTMessagingChannel_RunnerToDaemon-Protocol.h +39 -0
- package/PrivateHeaders/XCTest/XCTMessagingChannel_RunnerToIDE-Protocol.h +32 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_ActivityReporting-Protocol.h +24 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_AttachmentFutureResultStatusUpdating-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_BundleRequesting-Protocol.h +24 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_CapabilityExchange-Protocol.h +56 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_DebugLogging-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_EventSynthesis-Protocol.h +34 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_ForcePressureSupportQuerying-Protocol.h +25 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_HIDEventRecording-Protocol.h +25 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_MemoryTesting-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_PerformanceMeasurementReporting-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_ProcessMonitoring-Protocol.h +25 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_ProtectedResourceAuthorization-Protocol.h +22 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_ScreenRecording-Protocol.h +24 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_SelfDiagnosisIssueReporting-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_SignpostRequesting-Protocol.h +24 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_SiriAutomation-Protocol.h +27 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_SystemConfiguration-Protocol.h +27 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_TelemetrySending-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_TestExecution-Protocol.h +28 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_TestReporting-Protocol.h +40 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_UIAutomation-Protocol.h +29 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_UIAutomationRunnerEventReporting-Protocol.h +27 -0
- package/PrivateHeaders/XCTest/XCTMessagingRole_UserPresence-Protocol.h +24 -0
- package/PrivateHeaders/XCTest/XCTMetricDiagnosticHelper.h +49 -0
- package/PrivateHeaders/XCTest/XCTNSPredicateExpectationObject-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTPromise.h +30 -0
- package/PrivateHeaders/XCTest/XCTRemoteSignpostListenerProxy-Protocol.h +29 -0
- package/PrivateHeaders/XCTest/XCTRepetitionPolicy.h +43 -0
- package/PrivateHeaders/XCTest/XCTReportingSession.h +50 -0
- package/PrivateHeaders/XCTest/XCTReportingSessionConfiguration-Protocol.h +27 -0
- package/PrivateHeaders/XCTest/XCTReportingSessionIssueReporter-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTReportingSessionTestContainer-Protocol.h +26 -0
- package/PrivateHeaders/XCTest/XCTReportingSessionTestReporter.h +51 -0
- package/PrivateHeaders/XCTest/XCTRunnerAutomationSession-Protocol.h +38 -0
- package/PrivateHeaders/XCTest/XCTRunnerDaemonSession.h +96 -0
- package/PrivateHeaders/XCTest/XCTRunnerDaemonSessionUIAutomationDelegate-Protocol.h +33 -0
- package/PrivateHeaders/XCTest/XCTRunnerIDESession.h +99 -0
- package/PrivateHeaders/XCTest/XCTRunnerIDESessionDelegate-Protocol.h +24 -0
- package/PrivateHeaders/XCTest/XCTRuntimeDiagnosticsPolicy.h +36 -0
- package/PrivateHeaders/XCTest/XCTRuntimeIssueDetectionPolicy.h +39 -0
- package/PrivateHeaders/XCTest/XCTScreenCapturePolicy.h +35 -0
- package/PrivateHeaders/XCTest/XCTSignpostListener-Protocol.h +25 -0
- package/PrivateHeaders/XCTest/XCTSkippedTestContext.h +37 -0
- package/PrivateHeaders/XCTest/XCTSourceCodeContext.h +39 -0
- package/PrivateHeaders/XCTest/XCTSourceCodeLocation.h +31 -0
- package/PrivateHeaders/XCTest/XCTTagSelection.h +41 -0
- package/PrivateHeaders/XCTest/XCTTestIdentifier.h +81 -0
- package/PrivateHeaders/XCTest/XCTTestIdentifierSet.h +54 -0
- package/PrivateHeaders/XCTest/XCTTestSelection.h +35 -0
- package/PrivateHeaders/XCTest/XCTWaiter.h +54 -0
- package/PrivateHeaders/XCTest/XCTWaiterManagement-Protocol.h +24 -0
- package/PrivateHeaders/XCTest/XCTWaiterManager-Protocol.h +25 -0
- package/PrivateHeaders/XCTest/XCTWaiterWait.h +40 -0
- package/PrivateHeaders/XCTest/XCTest.h +53 -0
- package/PrivateHeaders/XCTest/XCTestCase.h +180 -0
- package/PrivateHeaders/XCTest/XCTestCaseDiscoveryUIAutomationDelegate-Protocol.h +20 -0
- package/PrivateHeaders/XCTest/XCTestCaseRun.h +28 -0
- package/PrivateHeaders/XCTest/XCTestCaseUIAutomationDelegate-Protocol.h +25 -0
- package/PrivateHeaders/XCTest/XCTestCastMethodNamesUIAutomationDelegate-Protocol.h +24 -0
- package/PrivateHeaders/XCTest/XCTestConfiguration.h +94 -0
- package/PrivateHeaders/XCTest/XCTestDriver.h +64 -0
- package/PrivateHeaders/XCTest/XCTestExpectation.h +50 -0
- package/PrivateHeaders/XCTest/XCTestExpectationDelegate-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCTestObservationCenter.h +60 -0
- package/PrivateHeaders/XCTest/XCTestRun.h +44 -0
- package/PrivateHeaders/XCTest/XCUIAXNotificationHandling-Protocol.h +25 -0
- package/PrivateHeaders/XCTest/XCUIAccessibilityInterface-Protocol.h +58 -0
- package/PrivateHeaders/XCTest/XCUIAlertMonitoring-Protocol.h +27 -0
- package/PrivateHeaders/XCTest/XCUIApplication.h +98 -0
- package/PrivateHeaders/XCTest/XCUIApplicationAutomationSessionProviding-Protocol.h +26 -0
- package/PrivateHeaders/XCTest/XCUIApplicationImpl.h +90 -0
- package/PrivateHeaders/XCTest/XCUIApplicationImplReporter-Protocol.h +26 -0
- package/PrivateHeaders/XCTest/XCUIApplicationManaging-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCUIApplicationMonitor-Protocol.h +43 -0
- package/PrivateHeaders/XCTest/XCUIApplicationOpenRequest.h +34 -0
- package/PrivateHeaders/XCTest/XCUIApplicationPlatformServicesProviderDelegate-Protocol.h +25 -0
- package/PrivateHeaders/XCTest/XCUIApplicationProcess.h +105 -0
- package/PrivateHeaders/XCTest/XCUIApplicationProcessDelegate-Protocol.h +25 -0
- package/PrivateHeaders/XCTest/XCUIApplicationProcessManaging-Protocol.h +26 -0
- package/PrivateHeaders/XCTest/XCUIApplicationProcessTracker-Protocol.h +28 -0
- package/PrivateHeaders/XCTest/XCUIApplicationRegistry.h +32 -0
- package/PrivateHeaders/XCTest/XCUIButtonConsole.h +26 -0
- package/PrivateHeaders/XCTest/XCUICoordinate.h +49 -0
- package/PrivateHeaders/XCTest/XCUIDevice.h +134 -0
- package/PrivateHeaders/XCTest/XCUIDeviceAutomationModeInterface-Protocol.h +25 -0
- package/PrivateHeaders/XCTest/XCUIDeviceDelayedAttachmentTransferSupportInterface-Protocol.h +22 -0
- package/PrivateHeaders/XCTest/XCUIDeviceEventAndStateInterface-Protocol.h +40 -0
- package/PrivateHeaders/XCTest/XCUIElement.h +207 -0
- package/PrivateHeaders/XCTest/XCUIElementAttributesPrivate-Protocol.h +26 -0
- package/PrivateHeaders/XCTest/XCUIElementEventTarget-Protocol.h +38 -0
- package/PrivateHeaders/XCTest/XCUIElementQuery.h +166 -0
- package/PrivateHeaders/XCTest/XCUIElementTypeQueryProvider_Private-Protocol.h +24 -0
- package/PrivateHeaders/XCTest/XCUIEventRecording-Protocol.h +37 -0
- package/PrivateHeaders/XCTest/XCUIHitPointResult.h +25 -0
- package/PrivateHeaders/XCTest/XCUIInterruptionMonitoring-Protocol.h +27 -0
- package/PrivateHeaders/XCTest/XCUIIssueDiagnosticsProviding-Protocol.h +23 -0
- package/PrivateHeaders/XCTest/XCUIKnobControl.h +26 -0
- package/PrivateHeaders/XCTest/XCUILocation.h +24 -0
- package/PrivateHeaders/XCTest/XCUIPlatformApplicationServicesProviding-Protocol.h +33 -0
- package/PrivateHeaders/XCTest/XCUIRemoteAccessibilityInterface-Protocol.h +45 -0
- package/PrivateHeaders/XCTest/XCUIRemoteDeviceRunner-Protocol.h +24 -0
- package/PrivateHeaders/XCTest/XCUIRemoteSiriInterface-Protocol.h +30 -0
- package/PrivateHeaders/XCTest/XCUIResetAuthorizationStatusOfProtectedResourcesInterface-Protocol.h +22 -0
- package/PrivateHeaders/XCTest/XCUIScreen.h +53 -0
- package/PrivateHeaders/XCTest/XCUIScreenDataSource-Protocol.h +35 -0
- package/PrivateHeaders/XCTest/XCUISiriService.h +39 -0
- package/PrivateHeaders/XCTest/XCUISystem.h +26 -0
- package/PrivateHeaders/XCTest/XCUIXcodeApplicationManaging-Protocol.h +27 -0
- package/PrivateHeaders/XCTest/_TtC10XCTestCore19XCTReportingContext.h +26 -0
- package/PrivateHeaders/XCTest/_XCTMessaging_VoidProtocol-Protocol.h +20 -0
- package/PrivateHeaders/XCTest/_XCTestObservationInternal-Protocol.h +26 -0
- package/PrivateHeaders/XCTest/_XCTestObservationPrivate-Protocol.h +27 -0
- package/README.md +57 -2
- package/Scripts/build-webdriveragent.mjs +93 -0
- package/Scripts/build.sh +137 -0
- package/Scripts/bundle-mobile-assets.sh +35 -0
- package/Scripts/embed-runner-icon.sh +118 -0
- package/Scripts/fetch-prebuilt-wda.mjs +81 -0
- package/Scripts/update-wda-version.mjs +44 -0
- package/WebDriverAgent.xcodeproj/project.pbxproj +8522 -0
- package/WebDriverAgent.xcodeproj/project.xcworkspace/contents.xcworkspacedata +7 -0
- package/WebDriverAgent.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +8 -0
- package/WebDriverAgent.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings +5 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/IntegrationApp.xcscheme +87 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/IntegrationApp_tvOS.xcscheme +78 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/IntegrationApp_watchOS.xcscheme +78 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/IntegrationTests_1.xcscheme +93 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/IntegrationTests_2.xcscheme +93 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/IntegrationTests_3.xcscheme +93 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/IntegrationTests_tvOS.xcscheme +93 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/IntegrationTests_watchOS.xcscheme +93 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/WebDriverAgentLib.xcscheme +125 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/WebDriverAgentLib_tvOS.xcscheme +95 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/WebDriverAgentLib_watchOS.xcscheme +85 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/WebDriverAgentRunner-nodebug.xcscheme +87 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/WebDriverAgentRunner.xcscheme +132 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/WebDriverAgentRunner_noauth.xcscheme +70 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/WebDriverAgentRunner_tvOS.xcscheme +123 -0
- package/WebDriverAgent.xcodeproj/xcshareddata/xcschemes/WebDriverAgentRunner_watchOS.xcscheme +128 -0
- package/WebDriverAgentLib/Categories/FBXCElementSnapshotWrapper+Helpers.h +100 -0
- package/WebDriverAgentLib/Categories/FBXCElementSnapshotWrapper+Helpers.m +192 -0
- package/WebDriverAgentLib/Categories/NSDictionary+FBUtf8SafeDictionary.h +39 -0
- package/WebDriverAgentLib/Categories/NSDictionary+FBUtf8SafeDictionary.m +105 -0
- package/WebDriverAgentLib/Categories/NSExpression+FBFormat.h +29 -0
- package/WebDriverAgentLib/Categories/NSExpression+FBFormat.m +34 -0
- package/WebDriverAgentLib/Categories/NSString+FBVisualLength.h +18 -0
- package/WebDriverAgentLib/Categories/NSString+FBVisualLength.m +18 -0
- package/WebDriverAgentLib/Categories/NSString+FBXMLSafeString.h +27 -0
- package/WebDriverAgentLib/Categories/NSString+FBXMLSafeString.m +30 -0
- package/WebDriverAgentLib/Categories/XCAXClient_iOS+FBSnapshotReqParams.h +26 -0
- package/WebDriverAgentLib/Categories/XCAXClient_iOS+FBSnapshotReqParams.m +181 -0
- package/WebDriverAgentLib/Categories/XCTIssue+FBPatcher.h +17 -0
- package/WebDriverAgentLib/Categories/XCTIssue+FBPatcher.m +35 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBAlert.h +47 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBAlert.m +179 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBFocused.h +23 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.h +186 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.m +674 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBQuiescence.h +24 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBQuiescence.m +28 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBTouchAction.h +82 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBTouchAction.m +198 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBUIInterruptions.h +22 -0
- package/WebDriverAgentLib/Categories/XCUIApplication+FBUIInterruptions.m +31 -0
- package/WebDriverAgentLib/Categories/XCUIApplicationProcess+FBQuiescence.h +27 -0
- package/WebDriverAgentLib/Categories/XCUIApplicationProcess+FBQuiescence.m +111 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBHealthCheck.h +30 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBHealthCheck.m +47 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.h +236 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m +478 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBHinge.h +41 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBHinge.m +215 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBRotation.h +46 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBRotation.m +108 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBVoiceOver.h +66 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBVoiceOver.m +218 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBAccessibility.h +29 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBAccessibility.m +50 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBCaching.h +19 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBCaching.m +36 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBClassChain.h +57 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBClassChain.m +239 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBCustomActions.h +27 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBCustomActions.m +127 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBFind.h +75 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBFind.m +146 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBForceTouch.h +38 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBForceTouch.m +55 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBIsVisible.h +28 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBIsVisible.m +78 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBMinMax.h +33 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBMinMax.m +75 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBPickerWheel.h +45 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBPickerWheel.m +59 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBResolve.h +37 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBResolve.m +51 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBScrolling.h +98 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBScrolling.m +465 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBSwiping.h +38 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBSwiping.m +56 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBTVFocuse.h +35 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBTVFocuse.m +71 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBTyping.h +97 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBTyping.m +233 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBUID.h +42 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBUID.m +85 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.h +108 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m +175 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBVisibleFrame.h +35 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBVisibleFrame.m +61 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBWebDriverAttributes.h +32 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBWebDriverAttributes.m +299 -0
- package/WebDriverAgentLib/Categories/XCUIElementQuery+FBHelpers.h +28 -0
- package/WebDriverAgentLib/Categories/XCUIElementQuery+FBHelpers.m +47 -0
- package/WebDriverAgentLib/Commands/AxeAuthCommands.h +30 -0
- package/WebDriverAgentLib/Commands/AxeAuthCommands.m +175 -0
- package/WebDriverAgentLib/Commands/AxeAutoScanCommands.h +19 -0
- package/WebDriverAgentLib/Commands/AxeAutoScanCommands.m +143 -0
- package/WebDriverAgentLib/Commands/AxeProductDeclaration.h +21 -0
- package/WebDriverAgentLib/Commands/AxeProductDeclaration.m +40 -0
- package/WebDriverAgentLib/Commands/AxeReportCommands.h +20 -0
- package/WebDriverAgentLib/Commands/AxeReportCommands.m +62 -0
- package/WebDriverAgentLib/Commands/AxeScanCommands.h +20 -0
- package/WebDriverAgentLib/Commands/AxeScanCommands.m +386 -0
- package/WebDriverAgentLib/Commands/AxeUsageCommands.h +27 -0
- package/WebDriverAgentLib/Commands/AxeUsageCommands.m +90 -0
- package/WebDriverAgentLib/Commands/FBAlertViewCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBAlertViewCommands.m +104 -0
- package/WebDriverAgentLib/Commands/FBCustomCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBCustomCommands.m +848 -0
- package/WebDriverAgentLib/Commands/FBDebugCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBDebugCommands.m +81 -0
- package/WebDriverAgentLib/Commands/FBElementCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBElementCommands.m +775 -0
- package/WebDriverAgentLib/Commands/FBFindElementCommands.h +18 -0
- package/WebDriverAgentLib/Commands/FBFindElementCommands.m +186 -0
- package/WebDriverAgentLib/Commands/FBOrientationCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBOrientationCommands.m +192 -0
- package/WebDriverAgentLib/Commands/FBScreenshotCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBScreenshotCommands.m +40 -0
- package/WebDriverAgentLib/Commands/FBSessionCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBSessionCommands.m +519 -0
- package/WebDriverAgentLib/Commands/FBTouchActionCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBTouchActionCommands.m +41 -0
- package/WebDriverAgentLib/Commands/FBTouchIDCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBTouchIDCommands.m +30 -0
- package/WebDriverAgentLib/Commands/FBUnknownCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBUnknownCommands.m +39 -0
- package/WebDriverAgentLib/Commands/FBVideoCommands.h +19 -0
- package/WebDriverAgentLib/Commands/FBVideoCommands.m +84 -0
- package/WebDriverAgentLib/FBAlert.h +104 -0
- package/WebDriverAgentLib/FBAlert.m +454 -0
- package/WebDriverAgentLib/Info.plist +26 -0
- package/WebDriverAgentLib/Routing/FBCommandHandler.h +38 -0
- package/WebDriverAgentLib/Routing/FBCommandStatus.h +80 -0
- package/WebDriverAgentLib/Routing/FBCommandStatus.m +279 -0
- package/WebDriverAgentLib/Routing/FBElement.h +98 -0
- package/WebDriverAgentLib/Routing/FBElementCache.h +61 -0
- package/WebDriverAgentLib/Routing/FBElementCache.m +100 -0
- package/WebDriverAgentLib/Routing/FBElementUtils.h +76 -0
- package/WebDriverAgentLib/Routing/FBElementUtils.m +153 -0
- package/WebDriverAgentLib/Routing/FBExceptionHandler.h +29 -0
- package/WebDriverAgentLib/Routing/FBExceptionHandler.m +65 -0
- package/WebDriverAgentLib/Routing/FBExceptions.h +69 -0
- package/WebDriverAgentLib/Routing/FBExceptions.m +27 -0
- package/WebDriverAgentLib/Routing/FBHTTPServer.h +97 -0
- package/WebDriverAgentLib/Routing/FBHTTPServer.m +955 -0
- package/WebDriverAgentLib/Routing/FBHTTPStatusCodes.h +581 -0
- package/WebDriverAgentLib/Routing/FBResponseJSONPayload.h +29 -0
- package/WebDriverAgentLib/Routing/FBResponseJSONPayload.m +58 -0
- package/WebDriverAgentLib/Routing/FBResponsePayload.h +74 -0
- package/WebDriverAgentLib/Routing/FBResponsePayload.m +148 -0
- package/WebDriverAgentLib/Routing/FBRoute.h +86 -0
- package/WebDriverAgentLib/Routing/FBRoute.m +183 -0
- package/WebDriverAgentLib/Routing/FBRouteRequest-Private.h +20 -0
- package/WebDriverAgentLib/Routing/FBRouteRequest.h +39 -0
- package/WebDriverAgentLib/Routing/FBRouteRequest.m +32 -0
- package/WebDriverAgentLib/Routing/FBScreenRecordingContainer.h +65 -0
- package/WebDriverAgentLib/Routing/FBScreenRecordingContainer.m +88 -0
- package/WebDriverAgentLib/Routing/FBScreenRecordingPromise.h +29 -0
- package/WebDriverAgentLib/Routing/FBScreenRecordingPromise.m +31 -0
- package/WebDriverAgentLib/Routing/FBScreenRecordingRequest.h +39 -0
- package/WebDriverAgentLib/Routing/FBScreenRecordingRequest.m +99 -0
- package/WebDriverAgentLib/Routing/FBSession-Private.h +26 -0
- package/WebDriverAgentLib/Routing/FBSession.h +179 -0
- package/WebDriverAgentLib/Routing/FBSession.m +575 -0
- package/WebDriverAgentLib/Routing/FBTCPSocket.h +117 -0
- package/WebDriverAgentLib/Routing/FBTCPSocket.m +244 -0
- package/WebDriverAgentLib/Routing/FBWebServer.h +68 -0
- package/WebDriverAgentLib/Routing/FBWebServer.m +306 -0
- package/WebDriverAgentLib/Routing/FBXCAccessibilityElement.h +34 -0
- package/WebDriverAgentLib/Routing/FBXCAccessibilityElement.m +17 -0
- package/WebDriverAgentLib/Routing/FBXCDeviceEvent.h +34 -0
- package/WebDriverAgentLib/Routing/FBXCDeviceEvent.m +42 -0
- package/WebDriverAgentLib/Routing/FBXCElementSnapshot.h +82 -0
- package/WebDriverAgentLib/Routing/FBXCElementSnapshot.m +9 -0
- package/WebDriverAgentLib/Routing/FBXCElementSnapshotWrapper.h +29 -0
- package/WebDriverAgentLib/Routing/FBXCElementSnapshotWrapper.m +114 -0
- package/WebDriverAgentLib/Routing/RouteRequest.h +28 -0
- package/WebDriverAgentLib/Routing/RouteRequest.m +25 -0
- package/WebDriverAgentLib/Routing/RouteResponse.h +30 -0
- package/WebDriverAgentLib/Routing/RouteResponse.m +54 -0
- package/WebDriverAgentLib/Utilities/FBAccessibilityTraits.h +20 -0
- package/WebDriverAgentLib/Utilities/FBAccessibilityTraits.m +61 -0
- package/WebDriverAgentLib/Utilities/FBActiveAppDetectionPoint.h +56 -0
- package/WebDriverAgentLib/Utilities/FBActiveAppDetectionPoint.m +115 -0
- package/WebDriverAgentLib/Utilities/FBAlertsMonitor.h +51 -0
- package/WebDriverAgentLib/Utilities/FBAlertsMonitor.m +110 -0
- package/WebDriverAgentLib/Utilities/FBBaseActionsSynthesizer.h +132 -0
- package/WebDriverAgentLib/Utilities/FBBaseActionsSynthesizer.m +165 -0
- package/WebDriverAgentLib/Utilities/FBCapabilities.h +43 -0
- package/WebDriverAgentLib/Utilities/FBCapabilities.m +24 -0
- package/WebDriverAgentLib/Utilities/FBClassChainQueryParser.h +99 -0
- package/WebDriverAgentLib/Utilities/FBClassChainQueryParser.m +666 -0
- package/WebDriverAgentLib/Utilities/FBConfiguration.h +379 -0
- package/WebDriverAgentLib/Utilities/FBConfiguration.m +476 -0
- package/WebDriverAgentLib/Utilities/FBDebugLogDelegateDecorator.h +26 -0
- package/WebDriverAgentLib/Utilities/FBDebugLogDelegateDecorator.m +49 -0
- package/WebDriverAgentLib/Utilities/FBElementHelpers.h +29 -0
- package/WebDriverAgentLib/Utilities/FBElementHelpers.m +21 -0
- package/WebDriverAgentLib/Utilities/FBElementTypeTransformer.h +45 -0
- package/WebDriverAgentLib/Utilities/FBElementTypeTransformer.m +149 -0
- package/WebDriverAgentLib/Utilities/FBErrorBuilder.h +64 -0
- package/WebDriverAgentLib/Utilities/FBErrorBuilder.m +75 -0
- package/WebDriverAgentLib/Utilities/FBFailureProofTestCase.h +19 -0
- package/WebDriverAgentLib/Utilities/FBFailureProofTestCase.m +74 -0
- package/WebDriverAgentLib/Utilities/FBImageProcessor.h +55 -0
- package/WebDriverAgentLib/Utilities/FBImageProcessor.m +197 -0
- package/WebDriverAgentLib/Utilities/FBImageUtils.h +25 -0
- package/WebDriverAgentLib/Utilities/FBImageUtils.m +80 -0
- package/WebDriverAgentLib/Utilities/FBKeyboard.h +37 -0
- package/WebDriverAgentLib/Utilities/FBKeyboard.m +123 -0
- package/WebDriverAgentLib/Utilities/FBLogger.h +32 -0
- package/WebDriverAgentLib/Utilities/FBLogger.m +47 -0
- package/WebDriverAgentLib/Utilities/FBMacros.h +66 -0
- package/WebDriverAgentLib/Utilities/FBMathUtils.h +100 -0
- package/WebDriverAgentLib/Utilities/FBMathUtils.m +147 -0
- package/WebDriverAgentLib/Utilities/FBMjpegServer.h +36 -0
- package/WebDriverAgentLib/Utilities/FBMjpegServer.m +248 -0
- package/WebDriverAgentLib/Utilities/FBNotificationsHelper.h +37 -0
- package/WebDriverAgentLib/Utilities/FBNotificationsHelper.m +29 -0
- package/WebDriverAgentLib/Utilities/FBPasteboard.h +40 -0
- package/WebDriverAgentLib/Utilities/FBPasteboard.m +176 -0
- package/WebDriverAgentLib/Utilities/FBProtocolHelpers.h +46 -0
- package/WebDriverAgentLib/Utilities/FBProtocolHelpers.m +144 -0
- package/WebDriverAgentLib/Utilities/FBReflectionUtils.h +23 -0
- package/WebDriverAgentLib/Utilities/FBReflectionUtils.m +31 -0
- package/WebDriverAgentLib/Utilities/FBRunLoopSpinner.h +77 -0
- package/WebDriverAgentLib/Utilities/FBRunLoopSpinner.m +94 -0
- package/WebDriverAgentLib/Utilities/FBRuntimeUtils.h +79 -0
- package/WebDriverAgentLib/Utilities/FBRuntimeUtils.m +112 -0
- package/WebDriverAgentLib/Utilities/FBScreen.h +49 -0
- package/WebDriverAgentLib/Utilities/FBScreen.m +128 -0
- package/WebDriverAgentLib/Utilities/FBScreenshot.h +44 -0
- package/WebDriverAgentLib/Utilities/FBScreenshot.m +231 -0
- package/WebDriverAgentLib/Utilities/FBSettings.h +51 -0
- package/WebDriverAgentLib/Utilities/FBSettings.m +45 -0
- package/WebDriverAgentLib/Utilities/FBSettingsHandler.h +35 -0
- package/WebDriverAgentLib/Utilities/FBSettingsHandler.m +398 -0
- package/WebDriverAgentLib/Utilities/FBTVNavigationTracker-Private.h +37 -0
- package/WebDriverAgentLib/Utilities/FBTVNavigationTracker.h +77 -0
- package/WebDriverAgentLib/Utilities/FBTVNavigationTracker.m +177 -0
- package/WebDriverAgentLib/Utilities/FBUnattachedAppLauncher.h +26 -0
- package/WebDriverAgentLib/Utilities/FBUnattachedAppLauncher.m +21 -0
- package/WebDriverAgentLib/Utilities/FBW3CActionsHelpers.h +42 -0
- package/WebDriverAgentLib/Utilities/FBW3CActionsHelpers.m +119 -0
- package/WebDriverAgentLib/Utilities/FBW3CActionsSynthesizer.h +19 -0
- package/WebDriverAgentLib/Utilities/FBW3CActionsSynthesizer.m +1011 -0
- package/WebDriverAgentLib/Utilities/FBWebServerParams.h +22 -0
- package/WebDriverAgentLib/Utilities/FBWebServerParams.m +23 -0
- package/WebDriverAgentLib/Utilities/FBXCAXClientProxy.h +171 -0
- package/WebDriverAgentLib/Utilities/FBXCAXClientProxy.m +240 -0
- package/WebDriverAgentLib/Utilities/FBXCTestDaemonsProxy.h +45 -0
- package/WebDriverAgentLib/Utilities/FBXCTestDaemonsProxy.m +362 -0
- package/WebDriverAgentLib/Utilities/FBXCodeCompatibility.h +73 -0
- package/WebDriverAgentLib/Utilities/FBXCodeCompatibility.m +129 -0
- package/WebDriverAgentLib/Utilities/FBXMLGenerationOptions.h +45 -0
- package/WebDriverAgentLib/Utilities/FBXMLGenerationOptions.m +25 -0
- package/WebDriverAgentLib/Utilities/FBXPath-Private.h +61 -0
- package/WebDriverAgentLib/Utilities/FBXPath.h +59 -0
- package/WebDriverAgentLib/Utilities/FBXPath.m +1087 -0
- package/WebDriverAgentLib/Utilities/FBXPathExtensions.h +40 -0
- package/WebDriverAgentLib/Utilities/FBXPathExtensions.m +418 -0
- package/WebDriverAgentLib/Utilities/LRUCache/LRUCache.h +66 -0
- package/WebDriverAgentLib/Utilities/LRUCache/LRUCache.m +149 -0
- package/WebDriverAgentLib/Utilities/LRUCache/LRUCacheNode.h +43 -0
- package/WebDriverAgentLib/Utilities/LRUCache/LRUCacheNode.m +51 -0
- package/WebDriverAgentLib/Utilities/NSPredicate+FBFormat.h +42 -0
- package/WebDriverAgentLib/Utilities/NSPredicate+FBFormat.m +69 -0
- package/WebDriverAgentLib/Utilities/XCTestPrivateSymbols.h +78 -0
- package/WebDriverAgentLib/Utilities/XCTestPrivateSymbols.m +127 -0
- package/WebDriverAgentLib/Utilities/XCUIApplicationProcessDelay.h +37 -0
- package/WebDriverAgentLib/Utilities/XCUIApplicationProcessDelay.m +83 -0
- package/WebDriverAgentLib/WebDriverAgentLib.h +61 -0
- package/WebDriverAgentRunner/Assets.xcassets/AppIcon.appiconset/Contents.json +14 -0
- package/WebDriverAgentRunner/Assets.xcassets/AppIcon.appiconset/icon-1024.png +0 -0
- package/WebDriverAgentRunner/Assets.xcassets/Contents.json +6 -0
- package/WebDriverAgentRunner/Info.plist +30 -0
- package/WebDriverAgentRunner/UITestingUITests.m +58 -0
- package/WebDriverAgentTests/IntegrationApp/COORDINATE_PROBE.md +52 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/AppDelegate.h +14 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/AppDelegate.m +38 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/FBAlertViewController.h +14 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/FBAlertViewController.m +82 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/FBCoordinateProbeViewController.h +4 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/FBCoordinateProbeViewController.m +194 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/FBNavigationController.h +12 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/FBNavigationController.m +25 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/FBScrollViewController.h +13 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/FBScrollViewController.m +52 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/FBTableDataSource.h +16 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/FBTableDataSource.m +35 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/SceneDelegate.h +20 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/SceneDelegate.m +81 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/TouchSpotView.h +17 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/TouchSpotView.m +28 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/TouchViewController.h +23 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/TouchViewController.m +29 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/TouchableView.h +30 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/TouchableView.m +119 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/ViewController.h +12 -0
- package/WebDriverAgentTests/IntegrationApp/Classes/ViewController.m +144 -0
- package/WebDriverAgentTests/IntegrationApp/Info.plist +71 -0
- package/WebDriverAgentTests/IntegrationApp/Resources/Base.lproj/Main.storyboard +650 -0
- package/WebDriverAgentTests/IntegrationApp/main.m +15 -0
- package/WebDriverAgentTests/IntegrationApp_tvOS/AppDelegate.h +13 -0
- package/WebDriverAgentTests/IntegrationApp_tvOS/AppDelegate.m +26 -0
- package/WebDriverAgentTests/IntegrationApp_tvOS/Info.plist +41 -0
- package/WebDriverAgentTests/IntegrationApp_tvOS/SceneDelegate.h +15 -0
- package/WebDriverAgentTests/IntegrationApp_tvOS/SceneDelegate.m +22 -0
- package/WebDriverAgentTests/IntegrationApp_tvOS/ViewController.h +13 -0
- package/WebDriverAgentTests/IntegrationApp_tvOS/ViewController.m +79 -0
- package/WebDriverAgentTests/IntegrationApp_tvOS/main.m +17 -0
- package/WebDriverAgentTests/IntegrationApp_watchOS/ContentView.swift +31 -0
- package/WebDriverAgentTests/IntegrationApp_watchOS/WatchSpikeApp.swift +18 -0
- package/WebDriverAgentTests/IntegrationTests/FBAlertTests.m +175 -0
- package/WebDriverAgentTests/IntegrationTests/FBAutoAlertsHandlerTests.m +79 -0
- package/WebDriverAgentTests/IntegrationTests/FBConfigurationTests.m +123 -0
- package/WebDriverAgentTests/IntegrationTests/FBDisplayGestureTests.m +541 -0
- package/WebDriverAgentTests/IntegrationTests/FBElementAttributeTests.m +273 -0
- package/WebDriverAgentTests/IntegrationTests/FBElementSwipingTests.m +222 -0
- package/WebDriverAgentTests/IntegrationTests/FBElementVisibilityTests.m +68 -0
- package/WebDriverAgentTests/IntegrationTests/FBFailureProofTestCaseTests.m +41 -0
- package/WebDriverAgentTests/IntegrationTests/FBForceTouchTests.m +88 -0
- package/WebDriverAgentTests/IntegrationTests/FBImageProcessorTests.m +116 -0
- package/WebDriverAgentTests/IntegrationTests/FBIntegrationAppTests.m +87 -0
- package/WebDriverAgentTests/IntegrationTests/FBIntegrationTestCase.h +101 -0
- package/WebDriverAgentTests/IntegrationTests/FBIntegrationTestCase.m +176 -0
- package/WebDriverAgentTests/IntegrationTests/FBKeyboardTests.m +61 -0
- package/WebDriverAgentTests/IntegrationTests/FBPasteboardTests.m +92 -0
- package/WebDriverAgentTests/IntegrationTests/FBPickerWheelSelectTests.m +55 -0
- package/WebDriverAgentTests/IntegrationTests/FBSafariAlertTests.m +77 -0
- package/WebDriverAgentTests/IntegrationTests/FBScreenTests.m +450 -0
- package/WebDriverAgentTests/IntegrationTests/FBScrollingTests.m +123 -0
- package/WebDriverAgentTests/IntegrationTests/FBSessionIntegrationTests.m +228 -0
- package/WebDriverAgentTests/IntegrationTests/FBTapTest.m +186 -0
- package/WebDriverAgentTests/IntegrationTests/FBTestMacros.h +33 -0
- package/WebDriverAgentTests/IntegrationTests/FBTypingTest.m +68 -0
- package/WebDriverAgentTests/IntegrationTests/FBVideoRecordingTests.m +63 -0
- package/WebDriverAgentTests/IntegrationTests/FBVoiceOverTests.m +103 -0
- package/WebDriverAgentTests/IntegrationTests/FBW3CMultiTouchActionsIntegrationTests.m +159 -0
- package/WebDriverAgentTests/IntegrationTests/FBW3CTouchActionsIntegrationTests.m +700 -0
- package/WebDriverAgentTests/IntegrationTests/FBW3CTypeActionsTests.m +184 -0
- package/WebDriverAgentTests/IntegrationTests/FBXPathIntegrationTests.m +260 -0
- package/WebDriverAgentTests/IntegrationTests/Info.plist +24 -0
- package/WebDriverAgentTests/IntegrationTests/XCElementSnapshotHelperTests.m +205 -0
- package/WebDriverAgentTests/IntegrationTests/XCElementSnapshotHitPointTests.m +30 -0
- package/WebDriverAgentTests/IntegrationTests/XCUIApplicationHelperTests.m +162 -0
- package/WebDriverAgentTests/IntegrationTests/XCUIDeviceHealthCheckTests.m +27 -0
- package/WebDriverAgentTests/IntegrationTests/XCUIDeviceHelperTests.m +236 -0
- package/WebDriverAgentTests/IntegrationTests/XCUIDeviceRotationTests.m +105 -0
- package/WebDriverAgentTests/IntegrationTests/XCUIElementAttributesTests.m +248 -0
- package/WebDriverAgentTests/IntegrationTests/XCUIElementFBFindTests.m +673 -0
- package/WebDriverAgentTests/IntegrationTests/XCUIElementHelperIntegrationTests.m +51 -0
- package/WebDriverAgentTests/IntegrationTests_tvOS/FBTVFocusIntegrationTests.m +84 -0
- package/WebDriverAgentTests/IntegrationTests_tvOS/Info.plist +24 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/IntegrationTests_watchOS-Bridging-Header.h +23 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDAAlertIntegrationTests.swift +25 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDAAppLifecycleIntegrationTests.swift +37 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDAClickIntegrationTests.swift +25 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDADeviceIntegrationTests.swift +92 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDAElementAttributeIntegrationTests.swift +39 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDAFindIntegrationTests.swift +101 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDAMjpegStreamingIntegrationTests.swift +81 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDAScreenshotAndSourceIntegrationTests.swift +54 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDATypingIntegrationTests.swift +73 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDAWatchInProcessTestCase.swift +51 -0
- package/WebDriverAgentTests/UnitTests/Doubles/XCElementSnapshotDouble.h +16 -0
- package/WebDriverAgentTests/UnitTests/Doubles/XCElementSnapshotDouble.m +110 -0
- package/WebDriverAgentTests/UnitTests/Doubles/XCUIApplicationDouble.h +17 -0
- package/WebDriverAgentTests/UnitTests/Doubles/XCUIApplicationDouble.m +66 -0
- package/WebDriverAgentTests/UnitTests/Doubles/XCUIElementDouble.h +55 -0
- package/WebDriverAgentTests/UnitTests/Doubles/XCUIElementDouble.m +114 -0
- package/WebDriverAgentTests/UnitTests/FBClassChainTests.m +313 -0
- package/WebDriverAgentTests/UnitTests/FBConfigurationTests.m +72 -0
- package/WebDriverAgentTests/UnitTests/FBCustomCommandsTests.m +144 -0
- package/WebDriverAgentTests/UnitTests/FBElementCacheTests.m +124 -0
- package/WebDriverAgentTests/UnitTests/FBElementTypeTransformerTests.m +45 -0
- package/WebDriverAgentTests/UnitTests/FBElementUtilitiesTests.m +76 -0
- package/WebDriverAgentTests/UnitTests/FBErrorBuilderTests.m +61 -0
- package/WebDriverAgentTests/UnitTests/FBExceptionHandlerTests.m +59 -0
- package/WebDriverAgentTests/UnitTests/FBHTTPServerSessionTests.m +151 -0
- package/WebDriverAgentTests/UnitTests/FBHTTPServerTests.m +458 -0
- package/WebDriverAgentTests/UnitTests/FBLRUCacheTests.m +161 -0
- package/WebDriverAgentTests/UnitTests/FBMathUtilsTests.m +196 -0
- package/WebDriverAgentTests/UnitTests/FBProtocolHelpersTests.m +81 -0
- package/WebDriverAgentTests/UnitTests/FBResponseJSONPayloadTests.m +76 -0
- package/WebDriverAgentTests/UnitTests/FBRouteTests.m +129 -0
- package/WebDriverAgentTests/UnitTests/FBRunLoopSpinnerTests.m +98 -0
- package/WebDriverAgentTests/UnitTests/FBRuntimeUtilsTests.m +45 -0
- package/WebDriverAgentTests/UnitTests/FBSDKVersionTests.m +66 -0
- package/WebDriverAgentTests/UnitTests/FBSessionTests.m +268 -0
- package/WebDriverAgentTests/UnitTests/FBTouchableViewTests.m +121 -0
- package/WebDriverAgentTests/UnitTests/FBXCAXClientProxyTests.m +90 -0
- package/WebDriverAgentTests/UnitTests/FBXMLSafeStringTests.m +35 -0
- package/WebDriverAgentTests/UnitTests/FBXPathTests.m +381 -0
- package/WebDriverAgentTests/UnitTests/Info.plist +24 -0
- package/WebDriverAgentTests/UnitTests/NSDictionaryFBUtf8SafeTests.m +77 -0
- package/WebDriverAgentTests/UnitTests/NSExpressionFBFormatTests.m +60 -0
- package/WebDriverAgentTests/UnitTests/NSPredicateFBFormatTests.m +72 -0
- package/WebDriverAgentTests/UnitTests/XCUIElementHelpersTests.m +50 -0
- package/WebDriverAgentTests/UnitTests_tvOS/Doubles/FBXCAccessibilityElementDouble.h +27 -0
- package/WebDriverAgentTests/UnitTests_tvOS/Doubles/FBXCAccessibilityElementDouble.m +23 -0
- package/WebDriverAgentTests/UnitTests_tvOS/Doubles/FBXCElementSnapshotDouble.h +43 -0
- package/WebDriverAgentTests/UnitTests_tvOS/Doubles/FBXCElementSnapshotDouble.m +24 -0
- package/WebDriverAgentTests/UnitTests_tvOS/Doubles/XCUIElementDouble.h +47 -0
- package/WebDriverAgentTests/UnitTests_tvOS/Doubles/XCUIElementDouble.m +81 -0
- package/WebDriverAgentTests/UnitTests_tvOS/FBTVNavigationTrackerTests.m +134 -0
- package/WebDriverAgentTests/UnitTests_tvOS/Info.plist +24 -0
- package/axeDevToolsXCUI.xcframework/Info.plist +50 -0
- package/axeDevToolsXCUI.xcframework/LICENSE-3RD-PARTY-axe-devtools-ios.md +29 -0
- package/axeDevToolsXCUI.xcframework/axe-devtools-ios-4.3.1.cdx.json +75 -0
- package/axeDevToolsXCUI.xcframework/axe-devtools-ios-4.3.1.spdx.json +67 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/HTMLReportTemplate.html +1912 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Headers/AxeTestBundleObserver.h +55 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Headers/axeDevToolsXCUI-Swift.h +1546 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Headers/axeDevToolsXCUI.h +17 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Info.plist +57 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/LICENSE.md +7 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios.abi.json +34308 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios.private.swiftinterface +927 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios.swiftdoc +0 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios.swiftinterface +927 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Modules/module.modulemap +10 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/axeDevToolsXCUI +0 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/HTMLReportTemplate.html +1912 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Headers/AxeTestBundleObserver.h +55 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Headers/axeDevToolsXCUI-Swift.h +3088 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Headers/axeDevToolsXCUI.h +17 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Info.plist +53 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/LICENSE.md +7 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios-simulator.abi.json +34308 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface +927 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios-simulator.swiftdoc +0 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios-simulator.swiftinterface +927 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/x86_64-apple-ios-simulator.abi.json +34308 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface +927 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/x86_64-apple-ios-simulator.swiftdoc +0 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/x86_64-apple-ios-simulator.swiftinterface +927 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/module.modulemap +10 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/_CodeSignature/CodeResources +278 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/axeDevToolsXCUI +0 -0
- package/build/lib/check-dependencies.d.ts +6 -0
- package/build/lib/check-dependencies.d.ts.map +1 -0
- package/build/lib/check-dependencies.js +50 -0
- package/build/lib/check-dependencies.js.map +1 -0
- package/build/lib/constants.d.ts +25 -0
- package/build/lib/constants.d.ts.map +1 -0
- package/build/lib/constants.js +28 -0
- package/build/lib/constants.js.map +1 -0
- package/build/lib/index.d.ts +7 -0
- package/build/lib/index.d.ts.map +1 -0
- package/build/lib/index.js +7 -0
- package/build/lib/index.js.map +1 -0
- package/build/lib/logger.d.ts +2 -0
- package/build/lib/logger.d.ts.map +1 -0
- package/build/lib/logger.js +3 -0
- package/build/lib/logger.js.map +1 -0
- package/build/lib/no-session-proxy.d.ts +7 -0
- package/build/lib/no-session-proxy.d.ts.map +1 -0
- package/build/lib/no-session-proxy.js +17 -0
- package/build/lib/no-session-proxy.js.map +1 -0
- package/build/lib/types.d.ts +206 -0
- package/build/lib/types.d.ts.map +1 -0
- package/build/lib/types.js +2 -0
- package/build/lib/types.js.map +1 -0
- package/build/lib/utils/index.d.ts +11 -0
- package/build/lib/utils/index.d.ts.map +1 -0
- package/build/lib/utils/index.js +13 -0
- package/build/lib/utils/index.js.map +1 -0
- package/build/lib/utils/module.d.ts +25 -0
- package/build/lib/utils/module.d.ts.map +1 -0
- package/build/lib/utils/module.js +47 -0
- package/build/lib/utils/module.js.map +1 -0
- package/build/lib/utils/platform.d.ts +19 -0
- package/build/lib/utils/platform.d.ts.map +1 -0
- package/build/lib/utils/platform.js +32 -0
- package/build/lib/utils/platform.js.map +1 -0
- package/build/lib/utils/processes.d.ts +34 -0
- package/build/lib/utils/processes.d.ts.map +1 -0
- package/build/lib/utils/processes.js +151 -0
- package/build/lib/utils/processes.js.map +1 -0
- package/build/lib/utils/security.d.ts +5 -0
- package/build/lib/utils/security.d.ts.map +1 -0
- package/build/lib/utils/security.js +12 -0
- package/build/lib/utils/security.js.map +1 -0
- package/build/lib/utils/xctestrun.d.ts +51 -0
- package/build/lib/utils/xctestrun.d.ts.map +1 -0
- package/build/lib/utils/xctestrun.js +135 -0
- package/build/lib/utils/xctestrun.js.map +1 -0
- package/build/lib/wda-strategies.d.ts +69 -0
- package/build/lib/wda-strategies.d.ts.map +1 -0
- package/build/lib/wda-strategies.js +247 -0
- package/build/lib/wda-strategies.js.map +1 -0
- package/build/lib/webdriveragent.d.ts +175 -0
- package/build/lib/webdriveragent.d.ts.map +1 -0
- package/build/lib/webdriveragent.js +540 -0
- package/build/lib/webdriveragent.js.map +1 -0
- package/build/lib/xcodebuild.d.ts +98 -0
- package/build/lib/xcodebuild.d.ts.map +1 -0
- package/build/lib/xcodebuild.js +562 -0
- package/build/lib/xcodebuild.js.map +1 -0
- package/build/tsconfig.tsbuildinfo +1 -0
- package/lib/check-dependencies.ts +64 -0
- package/lib/constants.ts +33 -0
- package/lib/index.ts +7 -0
- package/lib/logger.ts +3 -0
- package/lib/no-session-proxy.ts +19 -0
- package/lib/types.ts +238 -0
- package/lib/utils/index.ts +20 -0
- package/lib/utils/module.ts +66 -0
- package/lib/utils/platform.ts +34 -0
- package/lib/utils/processes.ts +174 -0
- package/lib/utils/security.ts +16 -0
- package/lib/utils/xctestrun.ts +188 -0
- package/lib/wda-strategies.ts +343 -0
- package/lib/webdriveragent.ts +642 -0
- package/lib/xcodebuild.ts +678 -0
- package/package.json +114 -3
|
@@ -0,0 +1,3088 @@
|
|
|
1
|
+
#if 0
|
|
2
|
+
#elif defined(__arm64__) && __arm64__
|
|
3
|
+
// Generated by Apple Swift version 6.3.3 effective-5.10 (swiftlang-6.3.3.1.3 clang-2100.1.1.101)
|
|
4
|
+
#ifndef AXEDEVTOOLSXCUI_SWIFT_H
|
|
5
|
+
#define AXEDEVTOOLSXCUI_SWIFT_H
|
|
6
|
+
#pragma clang diagnostic push
|
|
7
|
+
#pragma clang diagnostic ignored "-Wgcc-compat"
|
|
8
|
+
|
|
9
|
+
#if !defined(__has_include)
|
|
10
|
+
# define __has_include(x) 0
|
|
11
|
+
#endif
|
|
12
|
+
#if !defined(__has_attribute)
|
|
13
|
+
# define __has_attribute(x) 0
|
|
14
|
+
#endif
|
|
15
|
+
#if !defined(__has_feature)
|
|
16
|
+
# define __has_feature(x) 0
|
|
17
|
+
#endif
|
|
18
|
+
#if !defined(__has_warning)
|
|
19
|
+
# define __has_warning(x) 0
|
|
20
|
+
#endif
|
|
21
|
+
|
|
22
|
+
#if __has_include(<swift/objc-prologue.h>)
|
|
23
|
+
# include <swift/objc-prologue.h>
|
|
24
|
+
#endif
|
|
25
|
+
|
|
26
|
+
#pragma clang diagnostic ignored "-Wauto-import"
|
|
27
|
+
#if defined(__OBJC__)
|
|
28
|
+
#include <Foundation/Foundation.h>
|
|
29
|
+
#endif // defined(__OBJC__)
|
|
30
|
+
#if defined(__cplusplus)
|
|
31
|
+
#include <cstdint>
|
|
32
|
+
#include <cstddef>
|
|
33
|
+
#include <cstdbool>
|
|
34
|
+
#include <cstring>
|
|
35
|
+
#include <stdlib.h>
|
|
36
|
+
#include <new>
|
|
37
|
+
#include <type_traits>
|
|
38
|
+
#else
|
|
39
|
+
#include <stdint.h>
|
|
40
|
+
#include <stddef.h>
|
|
41
|
+
#include <stdbool.h>
|
|
42
|
+
#include <string.h>
|
|
43
|
+
#endif
|
|
44
|
+
#if defined(__cplusplus)
|
|
45
|
+
#pragma clang diagnostic push
|
|
46
|
+
#pragma clang diagnostic ignored "-Wnon-modular-include-in-framework-module"
|
|
47
|
+
#if defined(__arm64e__) && __has_include(<ptrauth.h>)
|
|
48
|
+
# include <ptrauth.h>
|
|
49
|
+
#else
|
|
50
|
+
#pragma clang diagnostic push
|
|
51
|
+
#pragma clang diagnostic ignored "-Wreserved-macro-identifier"
|
|
52
|
+
# ifndef __ptrauth_swift_value_witness_function_pointer
|
|
53
|
+
# define __ptrauth_swift_value_witness_function_pointer(x)
|
|
54
|
+
# endif
|
|
55
|
+
# ifndef __ptrauth_swift_class_method_pointer
|
|
56
|
+
# define __ptrauth_swift_class_method_pointer(x)
|
|
57
|
+
# endif
|
|
58
|
+
#pragma clang diagnostic pop
|
|
59
|
+
#endif
|
|
60
|
+
#pragma clang diagnostic pop
|
|
61
|
+
#endif
|
|
62
|
+
|
|
63
|
+
#if !defined(SWIFT_TYPEDEFS)
|
|
64
|
+
# define SWIFT_TYPEDEFS 1
|
|
65
|
+
# if __has_include(<uchar.h>)
|
|
66
|
+
# include <uchar.h>
|
|
67
|
+
# elif !defined(__cplusplus)
|
|
68
|
+
typedef unsigned char char8_t;
|
|
69
|
+
typedef uint_least16_t char16_t;
|
|
70
|
+
typedef uint_least32_t char32_t;
|
|
71
|
+
# endif
|
|
72
|
+
typedef float swift_float2 __attribute__((__ext_vector_type__(2)));
|
|
73
|
+
typedef float swift_float3 __attribute__((__ext_vector_type__(3)));
|
|
74
|
+
typedef float swift_float4 __attribute__((__ext_vector_type__(4)));
|
|
75
|
+
typedef double swift_double2 __attribute__((__ext_vector_type__(2)));
|
|
76
|
+
typedef double swift_double3 __attribute__((__ext_vector_type__(3)));
|
|
77
|
+
typedef double swift_double4 __attribute__((__ext_vector_type__(4)));
|
|
78
|
+
typedef int swift_int2 __attribute__((__ext_vector_type__(2)));
|
|
79
|
+
typedef int swift_int3 __attribute__((__ext_vector_type__(3)));
|
|
80
|
+
typedef int swift_int4 __attribute__((__ext_vector_type__(4)));
|
|
81
|
+
typedef unsigned int swift_uint2 __attribute__((__ext_vector_type__(2)));
|
|
82
|
+
typedef unsigned int swift_uint3 __attribute__((__ext_vector_type__(3)));
|
|
83
|
+
typedef unsigned int swift_uint4 __attribute__((__ext_vector_type__(4)));
|
|
84
|
+
#endif
|
|
85
|
+
|
|
86
|
+
#if !defined(SWIFT_PASTE)
|
|
87
|
+
# define SWIFT_PASTE_HELPER(x, y) x##y
|
|
88
|
+
# define SWIFT_PASTE(x, y) SWIFT_PASTE_HELPER(x, y)
|
|
89
|
+
#endif
|
|
90
|
+
#if !defined(SWIFT_METATYPE)
|
|
91
|
+
# define SWIFT_METATYPE(X) Class
|
|
92
|
+
#endif
|
|
93
|
+
#if !defined(SWIFT_CLASS_PROPERTY)
|
|
94
|
+
# if __has_feature(objc_class_property)
|
|
95
|
+
# define SWIFT_CLASS_PROPERTY(...) __VA_ARGS__
|
|
96
|
+
# else
|
|
97
|
+
# define SWIFT_CLASS_PROPERTY(...)
|
|
98
|
+
# endif
|
|
99
|
+
#endif
|
|
100
|
+
#if !defined(SWIFT_RUNTIME_NAME)
|
|
101
|
+
# if __has_attribute(objc_runtime_name)
|
|
102
|
+
# define SWIFT_RUNTIME_NAME(X) __attribute__((objc_runtime_name(X)))
|
|
103
|
+
# else
|
|
104
|
+
# define SWIFT_RUNTIME_NAME(X)
|
|
105
|
+
# endif
|
|
106
|
+
#endif
|
|
107
|
+
#if !defined(SWIFT_COMPILE_NAME)
|
|
108
|
+
# if __has_attribute(swift_name)
|
|
109
|
+
# define SWIFT_COMPILE_NAME(X) __attribute__((swift_name(X)))
|
|
110
|
+
# else
|
|
111
|
+
# define SWIFT_COMPILE_NAME(X)
|
|
112
|
+
# endif
|
|
113
|
+
#endif
|
|
114
|
+
#if !defined(SWIFT_METHOD_FAMILY)
|
|
115
|
+
# if __has_attribute(objc_method_family)
|
|
116
|
+
# define SWIFT_METHOD_FAMILY(X) __attribute__((objc_method_family(X)))
|
|
117
|
+
# else
|
|
118
|
+
# define SWIFT_METHOD_FAMILY(X)
|
|
119
|
+
# endif
|
|
120
|
+
#endif
|
|
121
|
+
#if !defined(SWIFT_NOESCAPE)
|
|
122
|
+
# if __has_attribute(noescape)
|
|
123
|
+
# define SWIFT_NOESCAPE __attribute__((noescape))
|
|
124
|
+
# else
|
|
125
|
+
# define SWIFT_NOESCAPE
|
|
126
|
+
# endif
|
|
127
|
+
#endif
|
|
128
|
+
#if !defined(SWIFT_RELEASES_ARGUMENT)
|
|
129
|
+
# if __has_attribute(ns_consumed)
|
|
130
|
+
# define SWIFT_RELEASES_ARGUMENT __attribute__((ns_consumed))
|
|
131
|
+
# else
|
|
132
|
+
# define SWIFT_RELEASES_ARGUMENT
|
|
133
|
+
# endif
|
|
134
|
+
#endif
|
|
135
|
+
#if !defined(SWIFT_WARN_UNUSED_RESULT)
|
|
136
|
+
# if __has_attribute(warn_unused_result)
|
|
137
|
+
# define SWIFT_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
|
|
138
|
+
# else
|
|
139
|
+
# define SWIFT_WARN_UNUSED_RESULT
|
|
140
|
+
# endif
|
|
141
|
+
#endif
|
|
142
|
+
#if !defined(SWIFT_NORETURN)
|
|
143
|
+
# if __has_attribute(noreturn)
|
|
144
|
+
# define SWIFT_NORETURN __attribute__((noreturn))
|
|
145
|
+
# else
|
|
146
|
+
# define SWIFT_NORETURN
|
|
147
|
+
# endif
|
|
148
|
+
#endif
|
|
149
|
+
#if !defined(SWIFT_CLASS_EXTRA)
|
|
150
|
+
# define SWIFT_CLASS_EXTRA
|
|
151
|
+
#endif
|
|
152
|
+
#if !defined(SWIFT_PROTOCOL_EXTRA)
|
|
153
|
+
# define SWIFT_PROTOCOL_EXTRA
|
|
154
|
+
#endif
|
|
155
|
+
#if !defined(SWIFT_ENUM_EXTRA)
|
|
156
|
+
# define SWIFT_ENUM_EXTRA
|
|
157
|
+
#endif
|
|
158
|
+
#if !defined(SWIFT_CLASS)
|
|
159
|
+
# if __has_attribute(objc_subclassing_restricted)
|
|
160
|
+
# define SWIFT_CLASS(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) __attribute__((objc_subclassing_restricted)) SWIFT_CLASS_EXTRA
|
|
161
|
+
# define SWIFT_CLASS_NAMED(SWIFT_NAME) __attribute__((objc_subclassing_restricted)) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
|
|
162
|
+
# else
|
|
163
|
+
# define SWIFT_CLASS(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
|
|
164
|
+
# define SWIFT_CLASS_NAMED(SWIFT_NAME) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
|
|
165
|
+
# endif
|
|
166
|
+
#endif
|
|
167
|
+
#if !defined(SWIFT_RESILIENT_CLASS)
|
|
168
|
+
# if __has_attribute(objc_class_stub)
|
|
169
|
+
# define SWIFT_RESILIENT_CLASS(SWIFT_NAME) SWIFT_CLASS(SWIFT_NAME) __attribute__((objc_class_stub))
|
|
170
|
+
# define SWIFT_RESILIENT_CLASS_NAMED(SWIFT_NAME) __attribute__((objc_class_stub)) SWIFT_CLASS_NAMED(SWIFT_NAME)
|
|
171
|
+
# else
|
|
172
|
+
# define SWIFT_RESILIENT_CLASS(SWIFT_NAME) SWIFT_CLASS(SWIFT_NAME)
|
|
173
|
+
# define SWIFT_RESILIENT_CLASS_NAMED(SWIFT_NAME) SWIFT_CLASS_NAMED(SWIFT_NAME)
|
|
174
|
+
# endif
|
|
175
|
+
#endif
|
|
176
|
+
#if !defined(SWIFT_PROTOCOL)
|
|
177
|
+
# define SWIFT_PROTOCOL(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) SWIFT_PROTOCOL_EXTRA
|
|
178
|
+
# define SWIFT_PROTOCOL_NAMED(SWIFT_NAME) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_PROTOCOL_EXTRA
|
|
179
|
+
#endif
|
|
180
|
+
#if !defined(SWIFT_EXTENSION)
|
|
181
|
+
# define SWIFT_EXTENSION(M) SWIFT_PASTE(M##_Swift_, __LINE__)
|
|
182
|
+
#endif
|
|
183
|
+
#if !defined(OBJC_DESIGNATED_INITIALIZER)
|
|
184
|
+
# if __has_attribute(objc_designated_initializer)
|
|
185
|
+
# define OBJC_DESIGNATED_INITIALIZER __attribute__((objc_designated_initializer))
|
|
186
|
+
# else
|
|
187
|
+
# define OBJC_DESIGNATED_INITIALIZER
|
|
188
|
+
# endif
|
|
189
|
+
#endif
|
|
190
|
+
#if !defined(SWIFT_ENUM_ATTR)
|
|
191
|
+
# if __has_attribute(enum_extensibility)
|
|
192
|
+
# define SWIFT_ENUM_ATTR(_extensibility) __attribute__((enum_extensibility(_extensibility)))
|
|
193
|
+
# else
|
|
194
|
+
# define SWIFT_ENUM_ATTR(_extensibility)
|
|
195
|
+
# endif
|
|
196
|
+
#endif
|
|
197
|
+
#if !defined(SWIFT_ENUM)
|
|
198
|
+
# if (defined(__cplusplus) && __cplusplus >= 201103L) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) || __has_feature(objc_fixed_enum)
|
|
199
|
+
# define SWIFT_ENUM(_type, _name, _extensibility) enum _name : _type _name; enum SWIFT_ENUM_ATTR(_extensibility) SWIFT_ENUM_EXTRA _name : _type
|
|
200
|
+
# if __has_feature(generalized_swift_name)
|
|
201
|
+
# define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME, _extensibility) enum _name : _type _name SWIFT_COMPILE_NAME(SWIFT_NAME); enum SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_ENUM_ATTR(_extensibility) SWIFT_ENUM_EXTRA _name : _type
|
|
202
|
+
# else
|
|
203
|
+
# define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME, _extensibility) SWIFT_ENUM(_type, _name, _extensibility)
|
|
204
|
+
# endif
|
|
205
|
+
# else
|
|
206
|
+
# define SWIFT_ENUM(_type, _name, _extensibility) _type _name; enum
|
|
207
|
+
# define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME, _extensibility) SWIFT_ENUM(_type, _name, _extensibility)
|
|
208
|
+
# endif
|
|
209
|
+
#endif
|
|
210
|
+
#if !defined(SWIFT_ENUM_TAG)
|
|
211
|
+
# if (defined(__cplusplus) && __cplusplus >= 201103L) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) || __has_feature(objc_fixed_enum)
|
|
212
|
+
# define SWIFT_ENUM_TAG enum
|
|
213
|
+
# else
|
|
214
|
+
# define SWIFT_ENUM_TAG
|
|
215
|
+
# endif
|
|
216
|
+
#endif
|
|
217
|
+
#if !defined(SWIFT_ENUM_FWD_DECL)
|
|
218
|
+
# if (defined(__cplusplus) && __cplusplus >= 201103L) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) || __has_feature(objc_fixed_enum)
|
|
219
|
+
# define SWIFT_ENUM_FWD_DECL(_type, _name) enum _name : _type;
|
|
220
|
+
# else
|
|
221
|
+
# define SWIFT_ENUM_FWD_DECL(_type, _name) typedef _type _name;
|
|
222
|
+
# endif
|
|
223
|
+
#endif
|
|
224
|
+
#if !defined(SWIFT_UNAVAILABLE)
|
|
225
|
+
# define SWIFT_UNAVAILABLE __attribute__((unavailable))
|
|
226
|
+
#endif
|
|
227
|
+
#if !defined(SWIFT_UNAVAILABLE_MSG)
|
|
228
|
+
# define SWIFT_UNAVAILABLE_MSG(msg) __attribute__((unavailable(msg)))
|
|
229
|
+
#endif
|
|
230
|
+
#if !defined(SWIFT_AVAILABILITY)
|
|
231
|
+
# define SWIFT_AVAILABILITY(plat, ...) __attribute__((availability(plat, __VA_ARGS__)))
|
|
232
|
+
#endif
|
|
233
|
+
#if !defined(SWIFT_AVAILABILITY_DOMAIN)
|
|
234
|
+
# define SWIFT_AVAILABILITY_DOMAIN(dom, ...) __attribute__((availability(domain: dom, __VA_ARGS__)))
|
|
235
|
+
#endif
|
|
236
|
+
#if !defined(SWIFT_WEAK_IMPORT)
|
|
237
|
+
# define SWIFT_WEAK_IMPORT __attribute__((weak_import))
|
|
238
|
+
#endif
|
|
239
|
+
#if !defined(SWIFT_DEPRECATED)
|
|
240
|
+
# define SWIFT_DEPRECATED __attribute__((deprecated))
|
|
241
|
+
#endif
|
|
242
|
+
#if !defined(SWIFT_DEPRECATED_MSG)
|
|
243
|
+
# define SWIFT_DEPRECATED_MSG(...) __attribute__((deprecated(__VA_ARGS__)))
|
|
244
|
+
#endif
|
|
245
|
+
#if !defined(SWIFT_DEPRECATED_OBJC)
|
|
246
|
+
# if __has_feature(attribute_diagnose_if_objc)
|
|
247
|
+
# define SWIFT_DEPRECATED_OBJC(Msg) __attribute__((diagnose_if(1, Msg, "warning")))
|
|
248
|
+
# else
|
|
249
|
+
# define SWIFT_DEPRECATED_OBJC(Msg) SWIFT_DEPRECATED_MSG(Msg)
|
|
250
|
+
# endif
|
|
251
|
+
#endif
|
|
252
|
+
#if defined(__OBJC__)
|
|
253
|
+
#if !defined(IBSegueAction)
|
|
254
|
+
# define IBSegueAction
|
|
255
|
+
#endif
|
|
256
|
+
#endif
|
|
257
|
+
#if !defined(SWIFT_EXTERN)
|
|
258
|
+
# if defined(__cplusplus)
|
|
259
|
+
# define SWIFT_EXTERN extern "C"
|
|
260
|
+
# else
|
|
261
|
+
# define SWIFT_EXTERN extern
|
|
262
|
+
# endif
|
|
263
|
+
#endif
|
|
264
|
+
#if !defined(SWIFT_CALL)
|
|
265
|
+
# define SWIFT_CALL __attribute__((swiftcall))
|
|
266
|
+
#endif
|
|
267
|
+
#if !defined(SWIFT_INDIRECT_RESULT)
|
|
268
|
+
# define SWIFT_INDIRECT_RESULT __attribute__((swift_indirect_result))
|
|
269
|
+
#endif
|
|
270
|
+
#if !defined(SWIFT_CONTEXT)
|
|
271
|
+
# define SWIFT_CONTEXT __attribute__((swift_context))
|
|
272
|
+
#endif
|
|
273
|
+
#if !defined(SWIFT_ERROR_RESULT)
|
|
274
|
+
# define SWIFT_ERROR_RESULT __attribute__((swift_error_result))
|
|
275
|
+
#endif
|
|
276
|
+
#if defined(__cplusplus)
|
|
277
|
+
# define SWIFT_NOEXCEPT noexcept
|
|
278
|
+
#else
|
|
279
|
+
# define SWIFT_NOEXCEPT
|
|
280
|
+
#endif
|
|
281
|
+
#if !defined(SWIFT_C_INLINE_THUNK)
|
|
282
|
+
# if __has_attribute(always_inline)
|
|
283
|
+
# if __has_attribute(nodebug)
|
|
284
|
+
# define SWIFT_C_INLINE_THUNK inline __attribute__((always_inline)) __attribute__((nodebug))
|
|
285
|
+
# else
|
|
286
|
+
# define SWIFT_C_INLINE_THUNK inline __attribute__((always_inline))
|
|
287
|
+
# endif
|
|
288
|
+
# else
|
|
289
|
+
# define SWIFT_C_INLINE_THUNK inline
|
|
290
|
+
# endif
|
|
291
|
+
#endif
|
|
292
|
+
#if defined(_WIN32)
|
|
293
|
+
#if !defined(SWIFT_IMPORT_STDLIB_SYMBOL)
|
|
294
|
+
# define SWIFT_IMPORT_STDLIB_SYMBOL __declspec(dllimport)
|
|
295
|
+
#endif
|
|
296
|
+
#else
|
|
297
|
+
#if !defined(SWIFT_IMPORT_STDLIB_SYMBOL)
|
|
298
|
+
# define SWIFT_IMPORT_STDLIB_SYMBOL
|
|
299
|
+
#endif
|
|
300
|
+
#endif
|
|
301
|
+
#if !__has_feature(nullability)
|
|
302
|
+
# define _Nonnull
|
|
303
|
+
# define _Nullable
|
|
304
|
+
# define _Null_unspecified
|
|
305
|
+
#elif !defined(__OBJC__)
|
|
306
|
+
# pragma clang diagnostic ignored "-Wnullability-extension"
|
|
307
|
+
#endif
|
|
308
|
+
#if !__has_feature(nullability_nullable_result)
|
|
309
|
+
# define _Nullable_result _Nullable
|
|
310
|
+
#endif
|
|
311
|
+
#if __has_feature(objc_modules)
|
|
312
|
+
#if __has_warning("-Watimport-in-framework-header")
|
|
313
|
+
#pragma clang diagnostic ignored "-Watimport-in-framework-header"
|
|
314
|
+
#endif
|
|
315
|
+
#endif
|
|
316
|
+
|
|
317
|
+
#pragma clang diagnostic ignored "-Wproperty-attribute-mismatch"
|
|
318
|
+
#pragma clang diagnostic ignored "-Wduplicate-method-arg"
|
|
319
|
+
#if __has_warning("-Wpragma-clang-attribute")
|
|
320
|
+
# pragma clang diagnostic ignored "-Wpragma-clang-attribute"
|
|
321
|
+
#endif
|
|
322
|
+
#pragma clang diagnostic ignored "-Wunknown-pragmas"
|
|
323
|
+
#pragma clang diagnostic ignored "-Wnullability"
|
|
324
|
+
#pragma clang diagnostic ignored "-Wdollar-in-identifier-extension"
|
|
325
|
+
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
|
|
326
|
+
|
|
327
|
+
#if __has_attribute(external_source_symbol)
|
|
328
|
+
# pragma push_macro("any")
|
|
329
|
+
# undef any
|
|
330
|
+
# pragma clang attribute push(__attribute__((external_source_symbol(language="Swift", defined_in="axeDevToolsXCUI",generated_declaration))), apply_to=any(function,enum,objc_interface,objc_category,objc_protocol))
|
|
331
|
+
# pragma pop_macro("any")
|
|
332
|
+
#endif
|
|
333
|
+
|
|
334
|
+
#if defined(__cplusplus)
|
|
335
|
+
extern "C" {
|
|
336
|
+
#endif
|
|
337
|
+
|
|
338
|
+
#if defined(__cplusplus)
|
|
339
|
+
} // extern "C"
|
|
340
|
+
#endif
|
|
341
|
+
#if __has_attribute(external_source_symbol)
|
|
342
|
+
# pragma clang attribute pop
|
|
343
|
+
#endif
|
|
344
|
+
#if defined(__OBJC__)
|
|
345
|
+
#if __has_feature(objc_modules)
|
|
346
|
+
#if __has_warning("-Watimport-in-framework-header")
|
|
347
|
+
#pragma clang diagnostic ignored "-Watimport-in-framework-header"
|
|
348
|
+
#endif
|
|
349
|
+
@import Foundation;
|
|
350
|
+
@import ObjectiveC;
|
|
351
|
+
#endif
|
|
352
|
+
|
|
353
|
+
#endif // defined(__OBJC__)
|
|
354
|
+
#pragma clang diagnostic ignored "-Wproperty-attribute-mismatch"
|
|
355
|
+
#pragma clang diagnostic ignored "-Wduplicate-method-arg"
|
|
356
|
+
#if __has_warning("-Wpragma-clang-attribute")
|
|
357
|
+
# pragma clang diagnostic ignored "-Wpragma-clang-attribute"
|
|
358
|
+
#endif
|
|
359
|
+
#pragma clang diagnostic ignored "-Wunknown-pragmas"
|
|
360
|
+
#pragma clang diagnostic ignored "-Wnullability"
|
|
361
|
+
#pragma clang diagnostic ignored "-Wdollar-in-identifier-extension"
|
|
362
|
+
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
|
|
363
|
+
|
|
364
|
+
#if __has_attribute(external_source_symbol)
|
|
365
|
+
# pragma push_macro("any")
|
|
366
|
+
# undef any
|
|
367
|
+
# pragma clang attribute push(__attribute__((external_source_symbol(language="Swift", defined_in="axeDevToolsXCUI",generated_declaration))), apply_to=any(function,enum,objc_interface,objc_category,objc_protocol))
|
|
368
|
+
# pragma pop_macro("any")
|
|
369
|
+
#endif
|
|
370
|
+
|
|
371
|
+
#if defined(__OBJC__)
|
|
372
|
+
|
|
373
|
+
@class NSString;
|
|
374
|
+
@class NSBundle;
|
|
375
|
+
@class NSDictionary;
|
|
376
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI15AutoScanManager")
|
|
377
|
+
@interface AutoScanManager : NSObject
|
|
378
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AutoScanManager * _Nonnull shared;)
|
|
379
|
+
+ (AutoScanManager * _Nonnull)shared SWIFT_WARN_UNUSED_RESULT;
|
|
380
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
381
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
382
|
+
- (BOOL)enableWithBundleId:(NSString * _Nonnull)bundleId apiKey:(NSString * _Nonnull)apiKey axeServiceUrl:(NSString * _Nonnull)axeServiceUrl axeAccountUrl:(NSString * _Nonnull)axeAccountUrl projectId:(NSString * _Nonnull)projectId uploadToDashboard:(BOOL)uploadToDashboard htmlReportPath:(NSString * _Nullable)htmlReportPath error:(NSError * _Nullable * _Nullable)error;
|
|
383
|
+
/// Captures the current screen state without requiring a gesture trigger.
|
|
384
|
+
/// Called from WDA after enable() to capture the initial screen.
|
|
385
|
+
- (void)captureInitialContext;
|
|
386
|
+
- (void)startWith:(NSBundle * _Nullable)testBundle;
|
|
387
|
+
- (NSDictionary * _Nonnull)runScansAndReport;
|
|
388
|
+
@end
|
|
389
|
+
|
|
390
|
+
/// Auto Scan control surface for Appium/WebDriverAgent.
|
|
391
|
+
/// Mirrors Android’s <code>AxeAppium</code> (<code>pauseAutoScan()</code> / <code>resumeAutoScan()</code>) so the downstream
|
|
392
|
+
/// Appium integration is call-site identical across platforms. Not intended for direct
|
|
393
|
+
/// in-test use — test authors should prefer <code>AxeAutoScan.skipScan { }</code>, which cannot be
|
|
394
|
+
/// left dangling.
|
|
395
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeAppium")
|
|
396
|
+
@interface AxeAppium : NSObject
|
|
397
|
+
/// Creates a control surface bound to the live Auto Scan session (<code>AutoScanManager.shared</code>).
|
|
398
|
+
- (nonnull instancetype)init;
|
|
399
|
+
/// Pauses Auto Scan capture. Gestures still execute normally; their screens are not captured.
|
|
400
|
+
/// Idempotent: calling while already paused is a no-op. Always pair with <code>resumeAutoScan()</code>.
|
|
401
|
+
- (void)pauseAutoScan;
|
|
402
|
+
/// Resumes Auto Scan capture after a pause.
|
|
403
|
+
/// Idempotent: calling while not paused is a no-op.
|
|
404
|
+
- (void)resumeAutoScan;
|
|
405
|
+
@end
|
|
406
|
+
|
|
407
|
+
/// Customer-facing entry point for excluding interactions from Auto Scan.
|
|
408
|
+
/// Auto Scan is enabled the usual way (via <code>axe_config.json</code>); this API only adjusts capture
|
|
409
|
+
/// behavior while a run is already in progress. Matches Android’s static
|
|
410
|
+
/// <code>AxeAutoScan.skipScan { }</code> so cross-platform call sites are identical.
|
|
411
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI11AxeAutoScan")
|
|
412
|
+
@interface AxeAutoScan : NSObject
|
|
413
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
414
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
415
|
+
@end
|
|
416
|
+
|
|
417
|
+
/// A class that contains the location and dimensions of a rectangle, in iOS points.
|
|
418
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI7AxeRect")
|
|
419
|
+
@interface AxeRect : NSObject
|
|
420
|
+
/// The left-most bounds of the frame, in pts. Equal to CGRect <code>minX</code> property.
|
|
421
|
+
@property (nonatomic, readonly) float left;
|
|
422
|
+
/// The right-most bounds of the frame, in pts.
|
|
423
|
+
@property (nonatomic, readonly) float right;
|
|
424
|
+
/// The top-most bounds of the frame, in pts. Equal to CGRect <code>minY</code> property.
|
|
425
|
+
@property (nonatomic, readonly) float top;
|
|
426
|
+
/// The bottom-most bounds of the frame, in pts.
|
|
427
|
+
@property (nonatomic, readonly) float bottom;
|
|
428
|
+
/// The height of the frame, in pts. Equal to <code>bottom - top</code>.
|
|
429
|
+
@property (nonatomic, readonly) float height;
|
|
430
|
+
/// The width of the frame, in pts. Equal to <code>right - left</code>.
|
|
431
|
+
@property (nonatomic, readonly) float width;
|
|
432
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
433
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
434
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
435
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
436
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
437
|
+
@end
|
|
438
|
+
|
|
439
|
+
/// A class that contains the location and dimensions of a rectangle, in on-screen pixels.
|
|
440
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeBounds")
|
|
441
|
+
@interface AxeBounds : AxeRect
|
|
442
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
443
|
+
@end
|
|
444
|
+
|
|
445
|
+
/// The configuration for an axeDevTools object.
|
|
446
|
+
/// By default, all <code>AxeRule</code>s will run, with the exception of <code>InaccessibleAction</code>, which is disabled by default (see <code>AxeRuleId.InaccessibleAction</code>, deprecated ahead of removal in the October 2026 release). You can use this object to ignore rules, or add custom rules that you define.
|
|
447
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI7AxeConf")
|
|
448
|
+
@interface AxeConf : NSObject
|
|
449
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
450
|
+
/// Creates a new <code>AxeConf</code> object. All rules are added by default. See <code>AxeRuleId</code> for a full list of available rules.
|
|
451
|
+
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
452
|
+
/// This method allows you to ignore (or re-introduce) results from any rule, including custom rules. By default, no rules (including custom rules) are ignored, with the exception of <code>InaccessibleAction</code>, which is ignored by default.
|
|
453
|
+
/// Deprecated. This API changes shape in the October 2026 release (#3074); see the release
|
|
454
|
+
/// migration note. Behavior is unchanged until then.
|
|
455
|
+
/// \param rule the rule’s <code>AxeRuleId</code> (or a custom rule’s class name) whose results should be ignored (or included), as a String.
|
|
456
|
+
///
|
|
457
|
+
/// \param shouldIgnore a <code>Bool</code> indicating whether the rule’s results should be ignored. Set to <code>true</code> if the rule’s results should be ignored, or <code>false</code> if the rule’s results should be included. Default value is <code>true</code>.
|
|
458
|
+
///
|
|
459
|
+
- (void)ignoreWithRule:(NSString * _Nonnull)rule :(BOOL)shouldIgnore SWIFT_DEPRECATED_MSG("Deprecated ahead of a shape change in the October 2026 release; see the release migration note. Behavior is unchanged until then.");
|
|
460
|
+
/// This method allows you to ignore (or re-introduce) results from any rule, including custom rules. By default, no rules (including custom rules) are ignored, with the exception of <code>InaccessibleAction</code>, which is ignored by default.
|
|
461
|
+
/// Deprecated. This API changes shape in the October 2026 release (#3074); see the release
|
|
462
|
+
/// migration note. Behavior is unchanged until then.
|
|
463
|
+
/// \param rules the <code>AxeRuleId</code>s (or classNames, for custom rules) of the rules you wish to ignore, as a <code>String</code>.
|
|
464
|
+
///
|
|
465
|
+
/// \param shouldIgnore a <code>Bool</code> indicating whether the set of rules should have their results ignored. Set to <code>true</code> if they should be ignored or <code>false</code> if they should be included. Default value is <code>true</code>.
|
|
466
|
+
///
|
|
467
|
+
- (void)ignoreWithRules:(NSArray<NSString *> * _Nonnull)rules :(BOOL)shouldIgnore SWIFT_DEPRECATED_MSG("Deprecated ahead of a shape change in the October 2026 release; see the release migration note. Behavior is unchanged until then.");
|
|
468
|
+
/// This method allows you to ignore all experimental rules. <code>InaccessibleAction</code>, the only
|
|
469
|
+
/// experimental rule, is already ignored by default (#2975), so this call is a no-op unless a
|
|
470
|
+
/// caller previously opted it back in.
|
|
471
|
+
/// Deprecated. Experimental rules are being retired and this method will be removed in the
|
|
472
|
+
/// October 2026 release (#3002). To keep a specific rule off, use <code>ignore(rule:)</code>, which is
|
|
473
|
+
/// itself deprecated ahead of a shape change in that same release (#3074).
|
|
474
|
+
- (void)ignoreExperimental SWIFT_DEPRECATED_MSG("Experimental rules are being retired and this method will be removed in the October 2026 release. To keep a rule off, use ignore(rule:); it is itself deprecated ahead of a shape change in that same release.");
|
|
475
|
+
/// Ignore specific rules for specific views, as defined in the provided dictionary, by Class or Accessibility Identifier.
|
|
476
|
+
/// Classes that inherit from a classname specified here will not be ignored. For example, if you specify that the rule <code>InScrollView</code> should not run on any <code>UILabel</code>, <code>InScrollView</code> will still run on the class <code>DQLabel</code> (which inherits from <code>UILabel</code>).
|
|
477
|
+
/// Deprecated. This API changes shape in the October 2026 release (#3074); see the release
|
|
478
|
+
/// migration note. Behavior is unchanged until then.
|
|
479
|
+
/// *
|
|
480
|
+
/// \param rulesFor A dictionary where each key, the Class name or Accessibility Identifier of a view, has a <code>Set</code> of <code>Strings</code> containing Rule Id’s to ignore.
|
|
481
|
+
///
|
|
482
|
+
- (void)ignoreWithRulesFor:(NSDictionary<NSString *, NSSet<NSString *> *> * _Nonnull)rulesFor SWIFT_DEPRECATED_MSG("Deprecated ahead of a shape change in the October 2026 release; see the release migration note. Behavior is unchanged until then.");
|
|
483
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
484
|
+
@end
|
|
485
|
+
|
|
486
|
+
@class AxeView;
|
|
487
|
+
@class AxeDevice;
|
|
488
|
+
@class AxeImage;
|
|
489
|
+
@class AxeMetaData;
|
|
490
|
+
/// Lives within AxeResult and contains meta data about the scan, device information, the screenshot, and the view hierarchy.
|
|
491
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI10AxeContext")
|
|
492
|
+
@interface AxeContext : NSObject
|
|
493
|
+
/// The view hierarchy of the scanned view.
|
|
494
|
+
@property (nonatomic, readonly, strong) AxeView * _Nonnull axeView;
|
|
495
|
+
/// Information about the device used for the scan.
|
|
496
|
+
@property (nonatomic, readonly, strong) AxeDevice * _Nonnull axeDevice;
|
|
497
|
+
/// A screenshot of the view that was scanned.
|
|
498
|
+
@property (nonatomic, readonly, strong) AxeImage * _Nonnull screenshot;
|
|
499
|
+
/// Additional meta data.
|
|
500
|
+
@property (nonatomic, strong) AxeMetaData * _Nonnull axeMetaData;
|
|
501
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
502
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
503
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
504
|
+
@end
|
|
505
|
+
|
|
506
|
+
@class AxeDevToolsResultKey;
|
|
507
|
+
@class AxeResult;
|
|
508
|
+
/// AxeDevTools class contains many static methods for you to set up testing for accessibility.
|
|
509
|
+
/// With this class, you can:
|
|
510
|
+
/// <ul>
|
|
511
|
+
/// <li>
|
|
512
|
+
/// set up an automated accessibility test for either an entire screen or a single view
|
|
513
|
+
/// </li>
|
|
514
|
+
/// <li>
|
|
515
|
+
/// add the floating action button to your application to scan the current screen’s contents for accessibility issues when pressed
|
|
516
|
+
/// </li>
|
|
517
|
+
/// <li>
|
|
518
|
+
/// configure your accessibility tests to suit your needs
|
|
519
|
+
/// </li>
|
|
520
|
+
/// </ul>
|
|
521
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI11AxeDevTools")
|
|
522
|
+
@interface AxeDevTools : NSObject
|
|
523
|
+
/// Set this property if you want to change which rules are run or if you want to add custom rules.
|
|
524
|
+
/// Deprecated. Ignoring rules and adding custom rules are moving directly onto <code>AxeDevTools</code>.
|
|
525
|
+
/// This property will be removed after the October 2026 release, once the replacement ships —
|
|
526
|
+
/// there is nothing to migrate to yet, so it continues to work exactly as it does today until then.
|
|
527
|
+
@property (nonatomic, strong) AxeConf * _Nonnull configuration SWIFT_DEPRECATED_MSG("Rule ignoring and custom rules are moving directly onto AxeDevTools. This property will be removed after the October 2026 release, once the replacement ships. No migration is possible yet; behavior is unchanged until then.");
|
|
528
|
+
/// Set this property to <code>true</code> if you want additional debug information for unexpected behavior.
|
|
529
|
+
/// We may request this to be turned on if an obscure bug is found.
|
|
530
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
531
|
+
+ (BOOL)debugStatements SWIFT_WARN_UNUSED_RESULT;
|
|
532
|
+
+ (void)setDebugStatements:(BOOL)value;
|
|
533
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable sessionId;
|
|
534
|
+
/// Retrieves the scan from the server. This can be used within UITests to assert things about a scan that was pushed to the server, such as the number of accessibility issues within a scan. Will throw an error if there was an issue retrieving the scan.
|
|
535
|
+
/// \param resultKey The AxeDevToolsResultKey of the scan you would like to retrieve from the server.
|
|
536
|
+
///
|
|
537
|
+
///
|
|
538
|
+
/// returns:
|
|
539
|
+
/// The scan from the server.
|
|
540
|
+
- (AxeResult * _Nullable)getResult:(AxeDevToolsResultKey * _Nonnull)resultKey error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned.");
|
|
541
|
+
/// Use this after calling <code>run</code> to send the scan to the server. Will throw an error if sending the scan was not successful.
|
|
542
|
+
/// \param result The result that should be pushed to the dashboard.
|
|
543
|
+
///
|
|
544
|
+
/// \param scanName A String to change the scan name to in the dashboard.
|
|
545
|
+
///
|
|
546
|
+
///
|
|
547
|
+
/// returns:
|
|
548
|
+
/// AxeDevToolsResultKey. This type is deprecated and will be removed after the October 2026
|
|
549
|
+
/// release when the mobile dashboard is decommissioned. In the legacy mobile-service flow
|
|
550
|
+
/// (<code>login(withAPIKey:)</code>) the key can still be used with <code>getResult</code>, <code>tagResult</code>, <code>deleteResult</code>,
|
|
551
|
+
/// and <code>updateScanName</code> until then. In the Developer Hub flow (<code>startScanSession()</code>) the key is a
|
|
552
|
+
/// local identifier only and cannot be used with those server methods.
|
|
553
|
+
- (AxeDevToolsResultKey * _Nullable)postResult:(AxeResult * _Nonnull)result withScanName:(NSString * _Nullable)scanName error:(NSError * _Nullable * _Nullable)error;
|
|
554
|
+
/// Use this after calling <code>run</code> to send the scan to the server. Will throw an error if sending the scan was not successful.
|
|
555
|
+
/// \param result The result that should be pushed to the dashboard.
|
|
556
|
+
///
|
|
557
|
+
/// \param tags A list of tags that should be associated with the scan, as an array of String.
|
|
558
|
+
///
|
|
559
|
+
/// \param scanName A String to change the scan name to in the dashboard.
|
|
560
|
+
///
|
|
561
|
+
///
|
|
562
|
+
/// returns:
|
|
563
|
+
/// AxeDevToolsResultKey. This type is deprecated and will be removed after the October 2026
|
|
564
|
+
/// release when the mobile dashboard is decommissioned. In the legacy mobile-service flow
|
|
565
|
+
/// (<code>login(withAPIKey:)</code>) the key can still be used with <code>getResult</code>, <code>tagResult</code>, <code>deleteResult</code>,
|
|
566
|
+
/// and <code>updateScanName</code> until then. In the Developer Hub flow (<code>startScanSession()</code>) the key is a
|
|
567
|
+
/// local identifier only and cannot be used with those server methods.
|
|
568
|
+
- (AxeDevToolsResultKey * _Nullable)postResult:(AxeResult * _Nonnull)result withTags:(NSArray<NSString *> * _Nonnull)tags withScanName:(NSString * _Nullable)scanName error:(NSError * _Nullable * _Nullable)error SWIFT_DEPRECATED_MSG("The 'withTags' parameter will be removed after the October 2026 release when the mobile dashboard is decommissioned.", "postResult:withScanName:error:");
|
|
569
|
+
/// Tags the scan in the dashboard with the strings provided. Will throw an error if there was an issue tagging the scan.
|
|
570
|
+
/// \param resultKey The AxeDevToolsResultKey of the scan you would like to tag.
|
|
571
|
+
///
|
|
572
|
+
/// \param tags The tags you would like to give the scan, as <code>[String]</code>.
|
|
573
|
+
///
|
|
574
|
+
- (BOOL)tagResult:(AxeDevToolsResultKey * _Nonnull)resultKey withTags:(NSArray<NSString *> * _Nonnull)tags error:(NSError * _Nullable * _Nullable)error SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned.");
|
|
575
|
+
/// Deletes the scan from the server. The scan will no longer be available on the dashboard. Will throw an error if there was an issue deleting the scan.
|
|
576
|
+
/// \param resultKey the AxeDevToolsResultKey of the scan that should be deleted from the server.
|
|
577
|
+
///
|
|
578
|
+
- (BOOL)deleteResult:(AxeDevToolsResultKey * _Nonnull)resultKey error:(NSError * _Nullable * _Nullable)error SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned.");
|
|
579
|
+
/// Sets or updates the scan name that is displayed in the dashboard. Will throw an error if there was an issue (re)naming the scan.
|
|
580
|
+
/// \param resultKey The AxeDevToolsResultKey of the scan you would like to update.
|
|
581
|
+
///
|
|
582
|
+
/// \param scanName The name you would like to give the scan.
|
|
583
|
+
///
|
|
584
|
+
- (BOOL)updateScanName:(AxeDevToolsResultKey * _Nonnull)resultKey to:(NSString * _Nonnull)scanName error:(NSError * _Nullable * _Nullable)error SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned.");
|
|
585
|
+
/// Utilize this API with your result from calling <code>run</code> and save your accessibility results locally to your machine as JSON.
|
|
586
|
+
/// \param result The AxeResult object returned from the <code>run</code> API.
|
|
587
|
+
///
|
|
588
|
+
/// \param path Specify the absolute path to save the JSON file
|
|
589
|
+
///
|
|
590
|
+
/// \param fileName Specify the filename to be used. Default value will be “<appIdentifier>-<screenTitle>” or if scanName if provided, “<appIdentifier>-<scanName>”.
|
|
591
|
+
///
|
|
592
|
+
/// \param scanName Provide a custom scan name, or if none provided, the default will be the screen’s title.
|
|
593
|
+
///
|
|
594
|
+
///
|
|
595
|
+
/// returns:
|
|
596
|
+
/// The absolute path of the saved file.
|
|
597
|
+
/// This function will not overwrite a file if the file already exists. Instead, it will attach a number to the end of the file name (for example, “<appIdentifier>-<screenTitle>-1.json”).
|
|
598
|
+
- (NSString * _Nullable)saveResult:(AxeResult * _Nonnull)result toAbsolutePath:(NSString * _Nonnull)path withFileName:(NSString * _Nonnull)fileName withScanName:(NSString * _Nullable)scanName error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
599
|
+
/// Utilize this API with your result from calling <code>run</code> and save your accessibility results locally to your machine as JSON.
|
|
600
|
+
/// \param result The AxeResult object returned from the <code>run</code> API.
|
|
601
|
+
///
|
|
602
|
+
/// \param path Specify which folder within your home directory you’d like you JSON saved to. If none is provided, the scan will save into a folder called “AxeDevToolsResults” in your home directory (/Users/yourname/).
|
|
603
|
+
///
|
|
604
|
+
/// \param fileName Specify the filename to be used. Default value will be “<appIdentifier>-<screenTitle>” or if scanName if provided, “<appIdentifier>-<scanName>”.
|
|
605
|
+
///
|
|
606
|
+
/// \param scanName Provide a custom scan name, or if none provided, the default will be the screen’s title.
|
|
607
|
+
///
|
|
608
|
+
///
|
|
609
|
+
/// returns:
|
|
610
|
+
/// The absolute path of the saved file.
|
|
611
|
+
/// This function will not overwrite a file if the file already exists. Instead, it will attach a number to the end of the file name (for example, “<appIdentifier>-<screenTitle>-1.json”).
|
|
612
|
+
- (NSString * _Nullable)saveResult:(AxeResult * _Nonnull)result toPath:(NSString * _Nonnull)path withFileName:(NSString * _Nonnull)fileName withScanName:(NSString * _Nullable)scanName error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
613
|
+
/// Use this in a UITest to analyze the accessibility of an application. Useful in testing views built in SwiftUI, Native iOS or React Native.
|
|
614
|
+
/// \param bundleId The bundle identifier of the application to test. Application must be loaded at the time of the test.
|
|
615
|
+
///
|
|
616
|
+
///
|
|
617
|
+
/// returns:
|
|
618
|
+
/// the scan, as an AxeResult.
|
|
619
|
+
- (AxeResult * _Nullable)runOnBundleIdentifier:(NSString * _Nonnull)bundleId error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
620
|
+
/// Use this in a UITest to analyze the accessibility of a screen or a view. Useful in testing views built in SwiftUI, Native iOS or React Native.
|
|
621
|
+
/// \param element The root element of the screen you wanted tested, or one component. Must be an XCUIElement.
|
|
622
|
+
///
|
|
623
|
+
///
|
|
624
|
+
/// returns:
|
|
625
|
+
/// the scan, as an AxeResult.
|
|
626
|
+
- (AxeResult * _Nullable)runOnElement:(id _Nonnull)element error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
627
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
628
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
629
|
+
@end
|
|
630
|
+
|
|
631
|
+
@class AxeReportResult;
|
|
632
|
+
@interface AxeDevTools (SWIFT_EXTENSION(axeDevToolsXCUI))
|
|
633
|
+
/// Generates an HTML report and logs an accessibility summary from all scan results
|
|
634
|
+
/// accumulated since the last call to this method (or since the instance was created).
|
|
635
|
+
/// Call this after one or more <code>run</code> calls to produce a self-contained HTML report
|
|
636
|
+
/// and a printed summary of every accessibility issue found across all scans.
|
|
637
|
+
/// Each call <em>flushes</em> the accumulated results, so subsequent calls only include
|
|
638
|
+
/// scans performed after the previous call. This makes it safe to call multiple
|
|
639
|
+
/// times within a single test run to produce separate reports per flow.
|
|
640
|
+
/// \param outputPath The directory where the report and summary files should
|
|
641
|
+
/// be saved. Accepts an absolute path or a <code>~</code>-prefixed path relative to the home
|
|
642
|
+
/// directory. Defaults to <code>~/AxeDevToolsMobileResults</code> when omitted or <code>nil</code>.
|
|
643
|
+
///
|
|
644
|
+
///
|
|
645
|
+
/// throws:
|
|
646
|
+
/// An error if the HTML report cannot be written to disk.
|
|
647
|
+
///
|
|
648
|
+
/// returns:
|
|
649
|
+
/// An <code>AxeReportResult</code> containing the path to the generated HTML file
|
|
650
|
+
/// and the full summary text that was logged to the console.
|
|
651
|
+
- (AxeReportResult * _Nullable)generateHtmlReportAndSummaryWithOutputPath:(NSString * _Nullable)outputPath error:(NSError * _Nullable * _Nullable)error;
|
|
652
|
+
@end
|
|
653
|
+
|
|
654
|
+
@interface AxeDevTools (SWIFT_EXTENSION(axeDevToolsXCUI))
|
|
655
|
+
/// This function logs you into the cloud instance of axeDevTools. You must have a valid session before utilizing the framework’s features.
|
|
656
|
+
/// <ul>
|
|
657
|
+
/// <li>
|
|
658
|
+
/// For Objective-C, pass in an empty String to the <code>url</code> parameter and the default server will be used.
|
|
659
|
+
/// </li>
|
|
660
|
+
/// <li>
|
|
661
|
+
/// Will throw an error if the API key is not valid.
|
|
662
|
+
/// </li>
|
|
663
|
+
/// <li>
|
|
664
|
+
/// Google authentication information does not work in this method.
|
|
665
|
+
/// </li>
|
|
666
|
+
/// </ul>
|
|
667
|
+
/// \param apiKey API Key for axeDevTools.
|
|
668
|
+
///
|
|
669
|
+
/// \param url URL of the server receiving the scans if it’s not Deque’s service. This should only be filled out for enterprises with their own instance.
|
|
670
|
+
///
|
|
671
|
+
///
|
|
672
|
+
/// returns:
|
|
673
|
+
/// An instantiated AxeDevTools object. You will not be able to scan anything without this object.
|
|
674
|
+
+ (AxeDevTools * _Nullable)loginWithAPIKey:(NSString * _Nonnull)apiKey toServer:(NSString * _Nonnull)url error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned. Use AxeDevTools.startScanSession(apiKey:axeAccountUrl:projectId:axeUploadResults:) instead; it targets the Axe Developer Hub");
|
|
675
|
+
/// Starts a session with the axeDevTools cloud instance using an API key and optional project ID.
|
|
676
|
+
/// Use this method to initialize axeDevTools for accessibility testing. A valid session is required before utilizing the framework’s features.
|
|
677
|
+
/// <ul>
|
|
678
|
+
/// <li>
|
|
679
|
+
/// If no <code>projectId</code> is provided, results can only be saved locally or posted to the Axe DevTools Mobile Dashboard. Provide a <code>projectId</code> to upload results to Axe Developer Hub.
|
|
680
|
+
/// </li>
|
|
681
|
+
/// <li>
|
|
682
|
+
/// For Objective-C, pass in an empty String to the <code>url</code> parameter and the default server will be used.
|
|
683
|
+
/// </li>
|
|
684
|
+
/// <li>
|
|
685
|
+
/// Will throw an error if the API key is not valid.
|
|
686
|
+
/// </li>
|
|
687
|
+
/// </ul>
|
|
688
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
689
|
+
///
|
|
690
|
+
/// \param url URL of the server receiving the scans if it’s not Deque’s service. This should only be filled out for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
691
|
+
///
|
|
692
|
+
/// \param projectId The project ID for uploading results to Axe Developer Hub. Defaults to empty string (no project).
|
|
693
|
+
///
|
|
694
|
+
///
|
|
695
|
+
/// throws:
|
|
696
|
+
/// An error if the API key is invalid or authentication fails.
|
|
697
|
+
///
|
|
698
|
+
/// returns:
|
|
699
|
+
/// An instantiated AxeDevTools object ready for accessibility testing.
|
|
700
|
+
+ (AxeDevTools * _Nullable)startSessionWithApiKey:(NSString * _Nonnull)apiKey url:(NSString * _Nonnull)url projectId:(NSString * _Nonnull)projectId error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned. Use AxeDevTools.startScanSession(apiKey:axeAccountUrl:projectId:axeUploadResults:) instead; it targets the Axe Developer Hub");
|
|
701
|
+
/// Starts a session asynchronously with the axeDevTools cloud instance using an API key and project ID.
|
|
702
|
+
/// This is the asynchronous version of <code>startSession(apiKey:url:projectId:)</code> that uses a completion handler to return results. A valid session is required before utilizing the framework’s features.
|
|
703
|
+
/// <ul>
|
|
704
|
+
/// <li>
|
|
705
|
+
/// For Objective-C, pass in an empty String to the <code>url</code> parameter and the default server will be used.
|
|
706
|
+
/// </li>
|
|
707
|
+
/// <li>
|
|
708
|
+
/// The completion handler is called with an error if the API key is not valid, or with <code>AxeClient.Errors.projectIdRequiredForUpload</code> if <code>axeUploadResults</code> is true and no <code>projectId</code> was supplied.
|
|
709
|
+
/// </li>
|
|
710
|
+
/// </ul>
|
|
711
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
712
|
+
///
|
|
713
|
+
/// \param url URL of the server receiving the scans if it’s not Deque’s service. This should only be filled out for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
714
|
+
///
|
|
715
|
+
/// \param projectId The project ID for uploading results to Axe Developer Hub.
|
|
716
|
+
///
|
|
717
|
+
/// \param completion A closure called when the session initialization completes. On success, provides an initialized <code>AxeDevTools</code> instance and a <code>nil</code> error. On failure, provides a <code>nil</code> instance and the error that occurred.
|
|
718
|
+
///
|
|
719
|
+
+ (void)startSessionWithApiKey:(NSString * _Nonnull)apiKey toServer:(NSString * _Nonnull)url usingProjectId:(NSString * _Nonnull)projectId :(void (^ _Nonnull)(AxeDevTools * _Nullable, NSError * _Nullable))completion SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned. Use AxeDevTools.startScanSession(withApiKey:withAxeAccountUrl:usingProjectId:axeUploadResults:_:) instead; it targets the Axe Developer Hub");
|
|
720
|
+
/// Starts a session with the axeDevTools cloud instance using an API key and project ID.
|
|
721
|
+
/// This is the recommended method to initialize axeDevTools for accessibility testing. A valid session is required before utilizing the framework’s features.
|
|
722
|
+
/// <ul>
|
|
723
|
+
/// <li>
|
|
724
|
+
/// For Objective-C, pass in an empty String to the <code>axeAccountUrl</code> parameter and the default server will be used.
|
|
725
|
+
/// </li>
|
|
726
|
+
/// <li>
|
|
727
|
+
/// Will throw an error if the API key or projectId is not valid, or if <code>axeUploadResults</code> is true and no <code>projectId</code> was supplied.
|
|
728
|
+
/// </li>
|
|
729
|
+
/// </ul>
|
|
730
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
731
|
+
///
|
|
732
|
+
/// \param axeAccountUrl URL of the server receiving the scans if it’s not Deque’s service. This should only be filled out for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
733
|
+
///
|
|
734
|
+
/// \param projectId The project ID for uploading results to Axe Developer Hub. Required when <code>axeUploadResults</code> is true; may be omitted only when <code>axeUploadResults</code> is false.
|
|
735
|
+
///
|
|
736
|
+
/// \param axeUploadResults Whether results from this session should be uploaded to Axe Developer Hub. Defaults to true.
|
|
737
|
+
///
|
|
738
|
+
///
|
|
739
|
+
/// throws:
|
|
740
|
+
/// An error if either <code>axeUploadResults</code> is true and <code>projectId</code> is absent or empty or if the API key or projectId is invalid or authentication fails.
|
|
741
|
+
///
|
|
742
|
+
/// returns:
|
|
743
|
+
/// An instantiated AxeDevTools object ready for accessibility testing.
|
|
744
|
+
+ (AxeDevTools * _Nullable)startScanSessionWithApiKey:(NSString * _Nonnull)apiKey axeAccountUrl:(NSString * _Nonnull)axeAccountUrl projectId:(NSString * _Nullable)projectId axeUploadResults:(BOOL)axeUploadResults error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
745
|
+
/// Starts a session asynchronously with the axeDevTools cloud instance using an API key and project ID.
|
|
746
|
+
/// This is the asynchronous version of <code>startScanSession(apiKey:axeAccountUrl:projectId:axeUploadResults:)</code> that uses a completion handler to return results. A valid session is required before utilizing the framework’s features.
|
|
747
|
+
/// <ul>
|
|
748
|
+
/// <li>
|
|
749
|
+
/// For Objective-C, pass in an empty String to the <code>axeAccountUrl</code> parameter and the default server will be used.
|
|
750
|
+
/// </li>
|
|
751
|
+
/// <li>
|
|
752
|
+
/// The completion handler is called with an error if the API key is not valid.
|
|
753
|
+
/// </li>
|
|
754
|
+
/// </ul>
|
|
755
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
756
|
+
///
|
|
757
|
+
/// \param axeAccountUrl URL of the server receiving the scans if it’s not Deque’s service. This should only be filled out for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
758
|
+
///
|
|
759
|
+
/// \param projectId The project ID for uploading results to Axe Developer Hub. Required when <code>axeUploadResults</code> is true; may be omitted only when <code>axeUploadResults</code> is false.
|
|
760
|
+
///
|
|
761
|
+
/// \param axeUploadResults Whether results from this session should be uploaded to Axe Developer Hub. Defaults to true.
|
|
762
|
+
///
|
|
763
|
+
/// \param completion A closure called when the session initialization completes. On success, provides an initialized <code>AxeDevTools</code> instance and a <code>nil</code> error. On failure, provides a <code>nil</code> instance and the error that occurred.
|
|
764
|
+
///
|
|
765
|
+
+ (void)startScanSessionWithApiKey:(NSString * _Nonnull)apiKey withAxeAccountUrl:(NSString * _Nonnull)axeAccountUrl usingProjectId:(NSString * _Nullable)projectId axeUploadResults:(BOOL)axeUploadResults :(void (^ _Nonnull)(AxeDevTools * _Nullable, NSError * _Nullable))completion;
|
|
766
|
+
/// Starts a session with the axeDevTools cloud instance using an API key and project ID.
|
|
767
|
+
/// Results from this session are always uploaded to Axe Developer Hub. To authenticate and scan
|
|
768
|
+
/// without uploading, use <code>startScanSessionWithApiKey:axeAccountUrl:projectId:axeUploadResults:error:</code>
|
|
769
|
+
/// with <code>axeUploadResults</code> set to <code>NO</code>.
|
|
770
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
771
|
+
///
|
|
772
|
+
/// \param axeAccountUrl URL of the server receiving the scans. Pass an empty string for Deque’s.
|
|
773
|
+
///
|
|
774
|
+
/// \param projectId The project ID for uploading results to Axe Developer Hub.
|
|
775
|
+
///
|
|
776
|
+
///
|
|
777
|
+
/// throws:
|
|
778
|
+
/// An error if the API key or projectId is invalid, or authentication fails.
|
|
779
|
+
///
|
|
780
|
+
/// returns:
|
|
781
|
+
/// An instantiated AxeDevTools object ready for accessibility testing.
|
|
782
|
+
+ (AxeDevTools * _Nullable)startScanSessionWithApiKey:(NSString * _Nonnull)apiKey axeAccountUrl:(NSString * _Nonnull)axeAccountUrl projectId:(NSString * _Nonnull)projectId error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
783
|
+
/// Starts a session asynchronously. Results are always uploaded to Axe Developer Hub; use the
|
|
784
|
+
/// <code>axeUploadResults:</code> variant with <code>NO</code> to authenticate and scan without uploading.
|
|
785
|
+
+ (void)startScanSessionWithApiKey:(NSString * _Nonnull)apiKey withAxeAccountUrl:(NSString * _Nonnull)axeAccountUrl usingProjectId:(NSString * _Nonnull)projectId :(void (^ _Nonnull)(AxeDevTools * _Nullable, NSError * _Nullable))completion;
|
|
786
|
+
/// Authenticates with a pre-obtained OAuth access token.
|
|
787
|
+
/// Use this when your integration already holds a valid Bearer token
|
|
788
|
+
/// (e.g., from an MCP server) and you want to run local scans without
|
|
789
|
+
/// uploading results to the Deque backend.
|
|
790
|
+
/// \param accessToken A valid OAuth access token (Bearer token).
|
|
791
|
+
///
|
|
792
|
+
/// \param axeAccountUrl URL of the axe account instance. Only needed for
|
|
793
|
+
/// enterprises with their own instance. Defaults to empty string (uses default server).
|
|
794
|
+
///
|
|
795
|
+
///
|
|
796
|
+
/// throws:
|
|
797
|
+
/// An error if the access token is invalid or authentication fails.
|
|
798
|
+
///
|
|
799
|
+
/// returns:
|
|
800
|
+
/// An initialized AxeDevTools object ready for local scanning.
|
|
801
|
+
+ (AxeDevTools * _Nullable)loginWithAccessToken:(NSString * _Nonnull)accessToken axeAccountUrl:(NSString * _Nonnull)axeAccountUrl error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
802
|
+
/// Authenticates with the Axe Developer Hub using an API key without creating a scan session.
|
|
803
|
+
/// Use this when you only need to validate credentials and run scans locally (no result upload).
|
|
804
|
+
/// <ul>
|
|
805
|
+
/// <li>
|
|
806
|
+
/// For Objective-C, pass in an empty String to the <code>axeAccountUrl</code> parameter and the default server will be used.
|
|
807
|
+
/// </li>
|
|
808
|
+
/// </ul>
|
|
809
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
810
|
+
///
|
|
811
|
+
/// \param axeAccountUrl URL of the axe account instance. Only needed for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
812
|
+
///
|
|
813
|
+
///
|
|
814
|
+
/// throws:
|
|
815
|
+
/// An error if the API key is invalid or authentication fails.
|
|
816
|
+
///
|
|
817
|
+
/// returns:
|
|
818
|
+
/// An initialized AxeDevTools object ready for local scanning.
|
|
819
|
+
+ (AxeDevTools * _Nullable)authenticateWithApiKey:(NSString * _Nonnull)apiKey axeAccountUrl:(NSString * _Nonnull)axeAccountUrl error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
820
|
+
@end
|
|
821
|
+
|
|
822
|
+
/// A scan’s unique identifier on the axeDevTools Mobile server. You can use the AxeDevToolsResultKey to retrieve, tag, and
|
|
823
|
+
/// delete scans on the server.
|
|
824
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI20AxeDevToolsResultKey") SWIFT_DEPRECATED_MSG("This will be removed after the October 2026 release when the mobile dashboard is decommissioned.")
|
|
825
|
+
@interface AxeDevToolsResultKey : NSObject
|
|
826
|
+
/// The name of the application that the scan came from. Should be the Bundle Identifier.
|
|
827
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull packageName;
|
|
828
|
+
/// A unique String associated with the user who pushed up the scan. This is not the same as the username.
|
|
829
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull userId;
|
|
830
|
+
/// A unique String associated with the specific scan.
|
|
831
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull resultId;
|
|
832
|
+
/// A unique String provided by the backend. If uuid was not provided by
|
|
833
|
+
/// the backend, the uuid will be the same as <code>resultId</code>. They may also
|
|
834
|
+
/// be the same in general.
|
|
835
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull uuid;
|
|
836
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
837
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
838
|
+
/// Use this in UI Testing to convert the Floating Action Button title into a valid AxeDevToolsResultKey. This can then be used to retrieve the scan from the server, tag it, change its name, and delete it.
|
|
839
|
+
/// This initializer will return <code>nil</code> if the given String is not in the expected format. If supplying the FAB’s title directly and this method is returning <code>nil</code>, it may mean that there was an error sending the scan to the server.
|
|
840
|
+
/// \param fabTitle The FloatingActionButton’s <code>title</code> or <code>label</code> property after it is tapped.
|
|
841
|
+
///
|
|
842
|
+
- (nullable instancetype)initWithFabTitle:(NSString * _Nonnull)fabTitle OBJC_DESIGNATED_INITIALIZER;
|
|
843
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
844
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
845
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
846
|
+
@end
|
|
847
|
+
|
|
848
|
+
/// Information about the device used when the scan was created.
|
|
849
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeDevice")
|
|
850
|
+
@interface AxeDevice : NSObject
|
|
851
|
+
/// The name of the device
|
|
852
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull name;
|
|
853
|
+
/// The operating system that the device was running. Will likely be “iOS”.
|
|
854
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull os;
|
|
855
|
+
/// The iOS version that the device was running at the time of the scan.
|
|
856
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull osVersion;
|
|
857
|
+
/// The device’s screen height, in pixels
|
|
858
|
+
@property (nonatomic, readonly) float screenHeight;
|
|
859
|
+
/// The device’s screen width, in pixels
|
|
860
|
+
@property (nonatomic, readonly) float screenWidth;
|
|
861
|
+
/// The number of pixels in one iOS point (pt)
|
|
862
|
+
@property (nonatomic, readonly) float scale;
|
|
863
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
864
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
865
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
866
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
867
|
+
@end
|
|
868
|
+
|
|
869
|
+
/// The type of object. Derived from <code>XCUIElement.ElementType</code>.
|
|
870
|
+
/// <h2>Why this enum covers macOS types too</h2>
|
|
871
|
+
/// Apple ships a <em>single</em> <code>XCUIElement.ElementType</code> enum across all platforms — the iPhoneOS XCTest header contains every case (rawValues 0…82) including the macOS-only ones (<code>drawer</code>, <code>dockItem</code>, <code>helpTag</code>, <code>touchBar</code>, etc.). There is no separate iOS-only or iPadOS-only enum: Apple reuses the same numeric value for the same conceptual element across platforms, and just doesn’t emit the macOS-specific cases when scanning iOS apps. Verified against Xcode 16’s iPhoneOS XCTest header at <code>XCTest.framework/Headers/XCUIElementTypes.h</code>.
|
|
872
|
+
/// We therefore mirror the <em>full</em> set of 0…82 here. This guarantees <code>AxeElementType(rawValue:)</code> succeeds for any rawValue Apple currently has in production, which prevents <code>"RawValue N not supported."</code> debug logs and keeps <code>AxeElement.elementType</code> from silently degrading to <code>.any</code> views for which Apple has a real type.
|
|
873
|
+
/// Cases without a trailing comment are available on iOS (and typically iPadOS / macOS too). A case is only annotated when it does <em>not</em> appear on iOS — either iPadOS-only or macOS-only. Our rules’ applicability checks don’t reference macOS-only types, so cases marked <code>macOS</code> will never end up in results from an iOS scan.
|
|
874
|
+
/// Note: the <code>// iPadOS</code>, <code>// macOS</code> annotations describe Apple’s emission behavior at time of writing — they are documentation, not compile-time guarantees. If Apple changes which types are emitted on which platforms in a future SDK, the annotations may drift; re-check against <code>XCUIElementTypes.h</code> when adopting a new Xcode.
|
|
875
|
+
/// If Apple ever extends the enum past 82, the fallback path in <code>AxeElementType-Ext.swift</code> will
|
|
876
|
+
/// throw <code>ElementTypeInitError</code> and log it at debug level — same behavior we’ve always had for
|
|
877
|
+
/// unknown rawValues.
|
|
878
|
+
typedef SWIFT_ENUM(NSUInteger, AxeElementType, open) {
|
|
879
|
+
AxeElementTypeAny = 0,
|
|
880
|
+
/// Any view not otherwise described by the other options available in this enum.
|
|
881
|
+
AxeElementTypeOther = 1,
|
|
882
|
+
AxeElementTypeApplication = 2,
|
|
883
|
+
AxeElementTypeGroup = 3,
|
|
884
|
+
AxeElementTypeWindow = 4,
|
|
885
|
+
AxeElementTypeSheet = 5,
|
|
886
|
+
AxeElementTypeDrawer = 6,
|
|
887
|
+
AxeElementTypeAlert = 7,
|
|
888
|
+
AxeElementTypeDialog = 8,
|
|
889
|
+
AxeElementTypeButton = 9,
|
|
890
|
+
AxeElementTypeRadioButton = 10,
|
|
891
|
+
AxeElementTypeRadioGroup = 11,
|
|
892
|
+
AxeElementTypeCheckBox = 12,
|
|
893
|
+
AxeElementTypeDisclosureTriangle = 13,
|
|
894
|
+
AxeElementTypePopUpButton = 14,
|
|
895
|
+
AxeElementTypeComboBox = 15,
|
|
896
|
+
AxeElementTypeMenuButton = 16,
|
|
897
|
+
AxeElementTypeToolbarButton = 17,
|
|
898
|
+
AxeElementTypePopover = 18,
|
|
899
|
+
AxeElementTypeKeyboard = 19,
|
|
900
|
+
AxeElementTypeKey = 20,
|
|
901
|
+
AxeElementTypeNavigationBar = 21,
|
|
902
|
+
AxeElementTypeTabBar = 22,
|
|
903
|
+
AxeElementTypeTabGroup = 23,
|
|
904
|
+
AxeElementTypeToolbar = 24,
|
|
905
|
+
AxeElementTypeStatusBar = 25,
|
|
906
|
+
AxeElementTypeTable = 26,
|
|
907
|
+
AxeElementTypeTableRow = 27,
|
|
908
|
+
AxeElementTypeTableColumn = 28,
|
|
909
|
+
AxeElementTypeOutline = 29,
|
|
910
|
+
AxeElementTypeOutlineRow = 30,
|
|
911
|
+
AxeElementTypeBrowser = 31,
|
|
912
|
+
AxeElementTypeCollectionView = 32,
|
|
913
|
+
AxeElementTypeSlider = 33,
|
|
914
|
+
AxeElementTypePageIndicator = 34,
|
|
915
|
+
AxeElementTypeProgressIndicator = 35,
|
|
916
|
+
AxeElementTypeActivityIndicator = 36,
|
|
917
|
+
AxeElementTypeSegmentedControl = 37,
|
|
918
|
+
AxeElementTypePicker = 38,
|
|
919
|
+
AxeElementTypePickerWheel = 39,
|
|
920
|
+
AxeElementTypeSwitch = 40,
|
|
921
|
+
AxeElementTypeToggle = 41,
|
|
922
|
+
AxeElementTypeLink = 42,
|
|
923
|
+
AxeElementTypeImage = 43,
|
|
924
|
+
AxeElementTypeIcon = 44,
|
|
925
|
+
AxeElementTypeSearchField = 45,
|
|
926
|
+
AxeElementTypeScrollView = 46,
|
|
927
|
+
AxeElementTypeScrollBar = 47,
|
|
928
|
+
AxeElementTypeStaticText = 48,
|
|
929
|
+
AxeElementTypeTextField = 49,
|
|
930
|
+
AxeElementTypeSecureTextField = 50,
|
|
931
|
+
AxeElementTypeDatePicker = 51,
|
|
932
|
+
AxeElementTypeTextView = 52,
|
|
933
|
+
AxeElementTypeMenu = 53,
|
|
934
|
+
AxeElementTypeMenuItem = 54,
|
|
935
|
+
AxeElementTypeMenuBar = 55,
|
|
936
|
+
AxeElementTypeMenuBarItem = 56,
|
|
937
|
+
AxeElementTypeMap = 57,
|
|
938
|
+
AxeElementTypeWebView = 58,
|
|
939
|
+
AxeElementTypeIncrementArrow = 59,
|
|
940
|
+
AxeElementTypeDecrementArrow = 60,
|
|
941
|
+
AxeElementTypeTimeline = 61,
|
|
942
|
+
AxeElementTypeRatingIndicator = 62,
|
|
943
|
+
AxeElementTypeValueIndicator = 63,
|
|
944
|
+
AxeElementTypeSplitGroup = 64,
|
|
945
|
+
AxeElementTypeSplitter = 65,
|
|
946
|
+
AxeElementTypeRelevanceIndicator = 66,
|
|
947
|
+
AxeElementTypeColorWell = 67,
|
|
948
|
+
AxeElementTypeHelpTag = 68,
|
|
949
|
+
AxeElementTypeMatte = 69,
|
|
950
|
+
AxeElementTypeDockItem = 70,
|
|
951
|
+
AxeElementTypeRuler = 71,
|
|
952
|
+
AxeElementTypeRulerMarker = 72,
|
|
953
|
+
AxeElementTypeGrid = 73,
|
|
954
|
+
AxeElementTypeLevelIndicator = 74,
|
|
955
|
+
AxeElementTypeCell = 75,
|
|
956
|
+
AxeElementTypeLayoutArea = 76,
|
|
957
|
+
AxeElementTypeLayoutItem = 77,
|
|
958
|
+
AxeElementTypeHandle = 78,
|
|
959
|
+
AxeElementTypeStepper = 79,
|
|
960
|
+
AxeElementTypeTab = 80,
|
|
961
|
+
AxeElementTypeTouchBar = 81,
|
|
962
|
+
AxeElementTypeStatusItem = 82,
|
|
963
|
+
};
|
|
964
|
+
|
|
965
|
+
/// A screenshot of a view, or the entire device’s screen.
|
|
966
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI8AxeImage")
|
|
967
|
+
@interface AxeImage : NSObject
|
|
968
|
+
/// The screenshot, converted to base64
|
|
969
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull base64png;
|
|
970
|
+
/// The size of the image, in pixels
|
|
971
|
+
@property (nonatomic, readonly, strong) AxeBounds * _Nonnull frame;
|
|
972
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
973
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
974
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
975
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
976
|
+
@end
|
|
977
|
+
|
|
978
|
+
/// How serious a failure of a rule is.
|
|
979
|
+
typedef SWIFT_ENUM(NSInteger, AxeImpact, open) {
|
|
980
|
+
/// the application is usable but has some annoyances. This is the least severe impact.
|
|
981
|
+
AxeImpactMINOR = 0,
|
|
982
|
+
/// the application is usable but may be slightly more difficult to use for some users.
|
|
983
|
+
AxeImpactMODERATE = 1,
|
|
984
|
+
/// the application is difficult to use for some users.
|
|
985
|
+
AxeImpactSERIOUS = 2,
|
|
986
|
+
/// the application may not be usable or may be very difficult to use for some users.
|
|
987
|
+
AxeImpactCRITICAL = 3,
|
|
988
|
+
};
|
|
989
|
+
|
|
990
|
+
SWIFT_ENUM_FWD_DECL(NSInteger, AxeProductKind)
|
|
991
|
+
SWIFT_ENUM_FWD_DECL(NSInteger, AxeUsageActor)
|
|
992
|
+
/// Lets a downstream integration (WebDriverAgent, the Desktop Mobile Analyzer) declare
|
|
993
|
+
/// which product is driving the current process, so Amplitude can distinguish an
|
|
994
|
+
/// Appium-driven scan (and its major version) from a customer calling the SDK directly.
|
|
995
|
+
/// Describes the <em>process</em>, not a scan session: set at most once, never cleared.
|
|
996
|
+
/// <code>AutoScanManager.tearDown()</code> must not reset it.
|
|
997
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI14AxeIntegration")
|
|
998
|
+
@interface AxeIntegration : NSObject
|
|
999
|
+
/// Called once per process by the integrating product to identify itself. A second
|
|
1000
|
+
/// call declaring a different product is logged and ignored, not silently applied.
|
|
1001
|
+
+ (void)declareProduct:(enum AxeProductKind)product version:(NSString * _Nonnull)version;
|
|
1002
|
+
/// Called once per process by the integrating layer (the Appium driver, the Desktop
|
|
1003
|
+
/// Analyzer, MCP) to say who triggered this session and which product surface it came
|
|
1004
|
+
/// from. Public so those layers can call it; deliberately absent from customer docs and
|
|
1005
|
+
/// not part of the supported surface.
|
|
1006
|
+
/// <em>Call this before session init.</em> A session captures these values when it starts
|
|
1007
|
+
/// (<code>AxeClient.usageAttribution</code>), and its usage-service events and session-init analytics
|
|
1008
|
+
/// event are all stamped from that one capture.
|
|
1009
|
+
/// A call that lands afterwards therefore applies to the <em>next</em> session started in this
|
|
1010
|
+
/// process, never to one already running. There is no warning for a late call, because
|
|
1011
|
+
/// the process cannot tell a mistimed call apart from correct setup for the next session.
|
|
1012
|
+
/// Unlike <code>declareProduct</code>, which ignores a conflicting second call, this is last write
|
|
1013
|
+
/// wins. The SDK appends the platform suffix, so pass <code>appium</code>, not <code>appium-ios</code>. A
|
|
1014
|
+
/// <code>productComponent</code> that sanitizes to nothing leaves the previous value in place
|
|
1015
|
+
/// rather than clearing it; the <code>actor</code> from the same call still applies.
|
|
1016
|
+
/// \param actor Whether a person or an automated run triggered the session.
|
|
1017
|
+
///
|
|
1018
|
+
/// \param productComponent The upstream product surface, unsuffixed, e.g. <code>mcp</code> or <code>appium</code>.
|
|
1019
|
+
///
|
|
1020
|
+
+ (void)setUsageWithActor:(enum AxeUsageActor)actor productComponent:(NSString * _Nonnull)productComponent;
|
|
1021
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1022
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1023
|
+
@end
|
|
1024
|
+
|
|
1025
|
+
/// The meta data of a scan.
|
|
1026
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI11AxeMetaData")
|
|
1027
|
+
@interface AxeMetaData : NSObject
|
|
1028
|
+
/// The application that was scanned
|
|
1029
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull appIdentifier;
|
|
1030
|
+
/// The time that the scan occurred
|
|
1031
|
+
@property (nonatomic, readonly) int64_t analysisTimestamp;
|
|
1032
|
+
/// The version of axeDevTools iOS used
|
|
1033
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull axeVersion;
|
|
1034
|
+
/// The title of the screen that was scanned, if available
|
|
1035
|
+
@property (nonatomic, copy) NSString * _Nonnull screenTitle;
|
|
1036
|
+
@property (nonatomic, readonly) BOOL isFullScreenForML;
|
|
1037
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
1038
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1039
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1040
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1041
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1042
|
+
@end
|
|
1043
|
+
|
|
1044
|
+
typedef SWIFT_ENUM(NSUInteger, AxeOrientation, open) {
|
|
1045
|
+
AxeOrientationAll = 0,
|
|
1046
|
+
AxeOrientationPortrait = 1,
|
|
1047
|
+
AxeOrientationLandscape = 2,
|
|
1048
|
+
};
|
|
1049
|
+
|
|
1050
|
+
/// A location on the screen, either in pixels or iOS points (pt). Usually converted from a CGPoint
|
|
1051
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI8AxePoint")
|
|
1052
|
+
@interface AxePoint : NSObject
|
|
1053
|
+
/// The horizontal location of the point.
|
|
1054
|
+
@property (nonatomic, readonly) NSInteger x;
|
|
1055
|
+
/// The vertical location of the point.
|
|
1056
|
+
@property (nonatomic, readonly) NSInteger y;
|
|
1057
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1058
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1059
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1060
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1061
|
+
@end
|
|
1062
|
+
|
|
1063
|
+
/// Downstream products that can explicitly identify themselves to the framework.
|
|
1064
|
+
/// <code>@objc</code>-bridged so a typo in an Objective-C caller is a build failure, not a silently
|
|
1065
|
+
/// wrong value. Raw values are a published wire contract: append only, never renumber.
|
|
1066
|
+
typedef SWIFT_ENUM(NSInteger, AxeProductKind, open) {
|
|
1067
|
+
AxeProductKindAppium2 = 0,
|
|
1068
|
+
AxeProductKindAppium3 = 1,
|
|
1069
|
+
AxeProductKindDesktopAnalyzer = 2,
|
|
1070
|
+
};
|
|
1071
|
+
|
|
1072
|
+
/// AxeProps are all properties used to help identify views in an application and to figure out whether a view is accessible
|
|
1073
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI8AxeProps")
|
|
1074
|
+
@interface AxeProps : NSObject
|
|
1075
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1076
|
+
/// Creates an empty AxeProps object.
|
|
1077
|
+
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
1078
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1079
|
+
@end
|
|
1080
|
+
|
|
1081
|
+
/// The result returned by <code>generateHtmlReportAndSummary()</code>, containing the
|
|
1082
|
+
/// path to the generated HTML report file and the full summary string that
|
|
1083
|
+
/// was logged to the console.
|
|
1084
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI15AxeReportResult")
|
|
1085
|
+
@interface AxeReportResult : NSObject
|
|
1086
|
+
/// The full path to the generated HTML report file.
|
|
1087
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull htmlReportPath;
|
|
1088
|
+
/// The aggregated summary text that was logged to the Xcode console.
|
|
1089
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull summary;
|
|
1090
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1091
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1092
|
+
@end
|
|
1093
|
+
|
|
1094
|
+
@class AxeRuleResult;
|
|
1095
|
+
/// This class contains all the information from one accessibility scan of a screen. This is a Swift representation of the JSON sent to the axe DevTools Mobile server (if using UI automated tests or manual tests). This can be used to assert number of accessibility failures and passes on one screen. It also contains the view hierarchy of what was scanned and which rules were run.
|
|
1096
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeResult")
|
|
1097
|
+
@interface AxeResult : NSObject
|
|
1098
|
+
@property (nonatomic, copy) NSString * _Nullable sessionId;
|
|
1099
|
+
@property (nonatomic, copy) NSString * _Nullable scanName;
|
|
1100
|
+
@property (nonatomic, copy) NSArray<NSString *> * _Nullable tags SWIFT_DEPRECATED_MSG("This will be removed after the October 2026 release when the mobile dashboard is decommissioned.");
|
|
1101
|
+
/// The configuration of the scan
|
|
1102
|
+
@property (nonatomic, readonly, strong) AxeConf * _Nonnull axeConf;
|
|
1103
|
+
/// Information about the screen that was scanned
|
|
1104
|
+
@property (nonatomic, readonly, strong) AxeContext * _Nonnull axeContext;
|
|
1105
|
+
/// A list of failing, passing, ignored, and incomplete results
|
|
1106
|
+
@property (nonatomic, readonly, copy) NSArray<AxeRuleResult *> * _Nonnull axeRuleResults;
|
|
1107
|
+
/// All failures in the scan
|
|
1108
|
+
@property (nonatomic, readonly, copy) NSArray<AxeRuleResult *> * _Nonnull failures;
|
|
1109
|
+
/// All passes in the scan
|
|
1110
|
+
@property (nonatomic, readonly, copy) NSArray<AxeRuleResult *> * _Nonnull passes;
|
|
1111
|
+
/// All incompletes in the scan
|
|
1112
|
+
@property (nonatomic, readonly, copy) NSArray<AxeRuleResult *> * _Nonnull incompletes;
|
|
1113
|
+
/// A complete description of the result. Contains summaries for each rule and prints out information about
|
|
1114
|
+
/// any failing views.
|
|
1115
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1116
|
+
/// Summary of the scan. Contains the number of failures, passes, and incompletes.
|
|
1117
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull shortDescription;
|
|
1118
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1119
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1120
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1121
|
+
@end
|
|
1122
|
+
|
|
1123
|
+
/// The view’s primary purpose.
|
|
1124
|
+
typedef SWIFT_ENUM(NSInteger, AxeRole, open) {
|
|
1125
|
+
/// The view’s primary purpose is to display text. Views that can be interacted with by a user, even if they also display text, are counted as controls.
|
|
1126
|
+
AxeRoleTextElement = 0,
|
|
1127
|
+
/// The view’s primary purpose is to be interacted with by the user. Views that have text within them that are also actionable (such as buttons, textFields, etc) are counted as controls.
|
|
1128
|
+
AxeRoleControl = 1,
|
|
1129
|
+
/// The view’s primary purpose is to display an image.
|
|
1130
|
+
AxeRoleImage = 2,
|
|
1131
|
+
/// The view’s primary purpose is otherwise not mentioned (layout views, background views, etc).
|
|
1132
|
+
AxeRoleGenericElement = 3,
|
|
1133
|
+
};
|
|
1134
|
+
|
|
1135
|
+
/// A unique name for each of the rules the SDK registers. Most run by default; <code>InaccessibleAction</code>
|
|
1136
|
+
/// is the current exception (disabled by default, see <code>AxeConf</code>).
|
|
1137
|
+
typedef SWIFT_ENUM(NSInteger, AxeRuleId, open) {
|
|
1138
|
+
/// Deprecated. Renamed to <code>a11yElementFocusBox</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1139
|
+
AxeRuleIdA11yElementFocusBox = 0,
|
|
1140
|
+
/// Deprecated. Renamed to <code>activeControlName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1141
|
+
AxeRuleIdActiveControlName = 1,
|
|
1142
|
+
/// Deprecated. Renamed to <code>associatedText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1143
|
+
AxeRuleIdAssociatedText = 2,
|
|
1144
|
+
/// Deprecated. Renamed to <code>clippedText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1145
|
+
AxeRuleIdClippedText = 3,
|
|
1146
|
+
/// Deprecated. Renamed to <code>collidingViews</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1147
|
+
AxeRuleIdCollidingViews = 4,
|
|
1148
|
+
/// Deprecated. Renamed to <code>colorContrast</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1149
|
+
AxeRuleIdColorContrast = 5,
|
|
1150
|
+
/// Deprecated. Renamed to <code>conflictingTraits</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1151
|
+
AxeRuleIdConflictingTraits = 6,
|
|
1152
|
+
/// Deprecated. Renamed to <code>focusableText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1153
|
+
AxeRuleIdFocusableText = 7,
|
|
1154
|
+
/// Deprecated. Renamed to <code>imageViewName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1155
|
+
AxeRuleIdImageViewName = 8,
|
|
1156
|
+
/// Deprecated. Renamed to <code>inScrollView</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1157
|
+
AxeRuleIdInScrollView = 9,
|
|
1158
|
+
/// Deprecated. The InaccessibleAction rule is removed entirely in October 2026 (#2995).
|
|
1159
|
+
AxeRuleIdInaccessibleAction = 10,
|
|
1160
|
+
/// Deprecated. Renamed to <code>labelAtFront</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1161
|
+
AxeRuleIdLabelAtFront = 11,
|
|
1162
|
+
/// Deprecated. Renamed to <code>labelInName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1163
|
+
AxeRuleIdLabelInName = 12,
|
|
1164
|
+
/// Deprecated. Renamed to <code>meaningfulAccessibleName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1165
|
+
AxeRuleIdMeaningfulAccessibleName = 13,
|
|
1166
|
+
/// Deprecated. Renamed to <code>nestedElementsName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1167
|
+
AxeRuleIdNestedElementsName = 14,
|
|
1168
|
+
/// Deprecated. Renamed to <code>screenOrientation</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1169
|
+
AxeRuleIdScreenOrientation = 15,
|
|
1170
|
+
/// Deprecated. Renamed to <code>screenTitle</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1171
|
+
AxeRuleIdScreenTitle = 16,
|
|
1172
|
+
/// Deprecated. Renamed to <code>supportsDynamicType</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1173
|
+
AxeRuleIdSupportsDynamicType = 17,
|
|
1174
|
+
/// Deprecated. Renamed to <code>touchTargetSize</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1175
|
+
AxeRuleIdTouchTargetSize = 18,
|
|
1176
|
+
/// Deprecated. Renamed to <code>touchTargetSpacing</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1177
|
+
AxeRuleIdTouchTargetSpacing = 19,
|
|
1178
|
+
};
|
|
1179
|
+
|
|
1180
|
+
SWIFT_ENUM_FWD_DECL(NSInteger, AxeStatus)
|
|
1181
|
+
/// A summary of one rule being run on one view.
|
|
1182
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI13AxeRuleResult")
|
|
1183
|
+
@interface AxeRuleResult : NSObject
|
|
1184
|
+
/// whether the view passed, failed, or returned incomplete on the rule
|
|
1185
|
+
@property (nonatomic, readonly) enum AxeStatus status;
|
|
1186
|
+
/// refers to the end-user impact behind issues found in your scans.
|
|
1187
|
+
/// Read more about impact in the References section of
|
|
1188
|
+
/// axe DevTools Mobile docs at docs.deque.com.
|
|
1189
|
+
@property (nonatomic, readonly) enum AxeImpact impact;
|
|
1190
|
+
/// the name of the rule that was run on the view
|
|
1191
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull ruleId;
|
|
1192
|
+
/// a brief description of the rule that was run on the view
|
|
1193
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull ruleSummary;
|
|
1194
|
+
/// the properties used to determine whether the view passes or fails a rule
|
|
1195
|
+
@property (nonatomic, readonly, strong) AxeProps * _Nonnull props;
|
|
1196
|
+
/// the view’s identifier, calculated from its hash
|
|
1197
|
+
/// This is identical to the AxeViewId present in AxeView
|
|
1198
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull axeViewId;
|
|
1199
|
+
/// whether the view is in the current screenshot. Will be false if the view is off-screen or behind a modal.
|
|
1200
|
+
@property (nonatomic, readonly) BOOL isVisibleToUser;
|
|
1201
|
+
/// Whether a rule is currently experimental or not.
|
|
1202
|
+
/// Deprecated. This flag does not determine whether a rule runs by default — that is decided by
|
|
1203
|
+
/// each rule’s own <code>ignored</code> default (see <code>AxeConf</code>). <code>InaccessibleAction</code>, the only experimental
|
|
1204
|
+
/// rule, is disabled by default (#2975) independently of this flag. A check on this property
|
|
1205
|
+
/// changes which results you filter, not which rules run. It will be removed in the October 2026 release.
|
|
1206
|
+
@property (nonatomic, readonly) BOOL experimental SWIFT_DEPRECATED_MSG("This flag does not determine whether a rule runs by default; it will be removed in the October 2026 release.");
|
|
1207
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1208
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1209
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1210
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1211
|
+
@end
|
|
1212
|
+
|
|
1213
|
+
/// A set of options for when a rule is run on a view.
|
|
1214
|
+
typedef SWIFT_ENUM(NSInteger, AxeStatus, open) {
|
|
1215
|
+
/// The view was not applicable to the rule.
|
|
1216
|
+
AxeStatusINAPPLICABLE = 0,
|
|
1217
|
+
/// The view ran into an error and needs to be reviewed for accessibility manually. (Needs Review)
|
|
1218
|
+
AxeStatusINCOMPLETE = 1,
|
|
1219
|
+
/// The view does not have an accessibility issue.
|
|
1220
|
+
AxeStatusPASS = 2,
|
|
1221
|
+
/// The view has an accessibility issue.
|
|
1222
|
+
AxeStatusFAIL = 3,
|
|
1223
|
+
/// The view was not checked for accessibility issues.
|
|
1224
|
+
AxeStatusIGNORED = 4,
|
|
1225
|
+
};
|
|
1226
|
+
|
|
1227
|
+
typedef SWIFT_ENUM(NSInteger, AxeSuccessCriteria, open) {
|
|
1228
|
+
AxeSuccessCriteriaWcag412 = 0,
|
|
1229
|
+
AxeSuccessCriteriaWcag143 = 1,
|
|
1230
|
+
AxeSuccessCriteriaWcag132 = 2,
|
|
1231
|
+
AxeSuccessCriteriaWcag111 = 3,
|
|
1232
|
+
AxeSuccessCriteriaWcag144 = 4,
|
|
1233
|
+
AxeSuccessCriteriaWcag211 = 5,
|
|
1234
|
+
AxeSuccessCriteriaWcag253 = 6,
|
|
1235
|
+
AxeSuccessCriteriaWcag134 = 7,
|
|
1236
|
+
AxeSuccessCriteriaWcag242 = 8,
|
|
1237
|
+
AxeSuccessCriteriaWcag255 = 9,
|
|
1238
|
+
AxeSuccessCriteriaWcag258 = 10,
|
|
1239
|
+
AxeSuccessCriteriaWcag131 = 11,
|
|
1240
|
+
AxeSuccessCriteriaUnknown = -1,
|
|
1241
|
+
};
|
|
1242
|
+
|
|
1243
|
+
/// One team membership of the actor driving this process.
|
|
1244
|
+
/// The same type carries a team from walnut’s API-key validate response, through
|
|
1245
|
+
/// <code>AxeClient.analyticsTeams</code>, onto the usage service body and the Amplitude event. Mirroring
|
|
1246
|
+
/// walnut’s <code>{ id, name }</code> shape end to end means nothing in the chain translates it,
|
|
1247
|
+
/// so a team stamped on an event is what walnut reported, minus anything
|
|
1248
|
+
/// <code>AxeTeams.sanitize(_:)</code> refused to send (#3130).
|
|
1249
|
+
/// <code>@objc</code>-bridged because the injection entry point (<code>AxeTeams.setTeams(_:)</code>) is, and
|
|
1250
|
+
/// Objective-C cannot see a Swift struct.
|
|
1251
|
+
/// <code>@unchecked Sendable</code> rather than <code>Sendable</code>: every stored property is an immutable
|
|
1252
|
+
/// <code>String</code>, but the compiler cannot infer that through the non-<code>Sendable</code> <code>NSObject</code>
|
|
1253
|
+
/// superclass the <code>@objc</code> bridge requires. Instances cross threads, since a host can
|
|
1254
|
+
/// inject them from any thread and they are read on whichever thread sends an event.
|
|
1255
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI7AxeTeam")
|
|
1256
|
+
@interface AxeTeam : NSObject
|
|
1257
|
+
/// Walnut’s team id. Stable across renames, so this is what attribution keys on.
|
|
1258
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull id;
|
|
1259
|
+
/// Display name at the time the event was sent. Mutable on walnut’s side, which is
|
|
1260
|
+
/// why <code>id</code> and not this is the identity.
|
|
1261
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull name;
|
|
1262
|
+
- (nonnull instancetype)initWithId:(NSString * _Nonnull)id name:(NSString * _Nonnull)name OBJC_DESIGNATED_INITIALIZER;
|
|
1263
|
+
/// Suppresses the <code>init()</code> the <code>@objc</code>/<code>NSObject</code> bridge would otherwise publish.
|
|
1264
|
+
/// <code>id</code> and <code>name</code> are non-optional with no defaults, so a bridged <code>-init</code> could only
|
|
1265
|
+
/// produce an unusable instance; an Objective-C caller must use <code>initWithId:name:</code>.
|
|
1266
|
+
/// Carries a body, unlike the empty <code>{}</code> on <code>AxeTeams</code> and <code>AxeIntegration</code>: those are
|
|
1267
|
+
/// static namespaces with no stored properties, so an empty body compiles. Here it does
|
|
1268
|
+
/// not, because <code>id</code> and <code>name</code> would be left uninitialized.
|
|
1269
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1270
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1271
|
+
/// Value semantics for a value-shaped type: without this, <code>NSObject</code>’s identity
|
|
1272
|
+
/// comparison would report two teams carrying the same id and name as different.
|
|
1273
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1274
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
1275
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1276
|
+
@end
|
|
1277
|
+
|
|
1278
|
+
/// The host-injection channel for the actor’s team memberships, which are stamped onto
|
|
1279
|
+
/// every usage service and Amplitude event so MAU reporting can slice by team without a
|
|
1280
|
+
/// later join against billing-service (#3130).
|
|
1281
|
+
/// Teams reach an event from one of two places, and the split matters:
|
|
1282
|
+
/// <ol>
|
|
1283
|
+
/// <li>
|
|
1284
|
+
/// <em>Login</em>, which is <em>not</em> stored here. <code>AxeClient</code> keeps the teams walnut returned
|
|
1285
|
+
/// for its own session on the client itself, beside <code>analyticsUserId</code> and
|
|
1286
|
+
/// <code>analyticsOrgName</code>, and hands them to <code>Amplitude</code> and <code>UsageServiceClient</code> when it
|
|
1287
|
+
/// constructs them. Keeping them per client is what stops two live <code>AxeDevTools</code>
|
|
1288
|
+
/// instances (a host’s own session and <code>AutoScanManager</code>‘s, say) from stamping each
|
|
1289
|
+
/// other’s teams onto their events.
|
|
1290
|
+
/// </li>
|
|
1291
|
+
/// <li>
|
|
1292
|
+
/// <em>Injection</em>, which is stored here, because it is genuinely process-wide: a host
|
|
1293
|
+
/// app calling <code>setTeams(_:)</code> is asserting who is signed in <em>right now</em>, not speaking
|
|
1294
|
+
/// for one client. An injected value therefore overrides the login value on every
|
|
1295
|
+
/// client until a login supersedes it.
|
|
1296
|
+
/// </li>
|
|
1297
|
+
/// </ol>
|
|
1298
|
+
/// An injection outlives any one SDK session and is cleared only by the host replacing
|
|
1299
|
+
/// it, because only the host knows when its own session changed. A login deliberately
|
|
1300
|
+
/// does not clear it: with more than one live client (a host’s own session and
|
|
1301
|
+
/// <code>AutoScanManager</code>‘s, say) one client’s login would otherwise wipe an injection that
|
|
1302
|
+
/// belongs to another. A host that logs out injects an empty array, which is honoured.
|
|
1303
|
+
/// Reads never throw and never block on a lookup: an unknown actor sends <code>teams: []</code>
|
|
1304
|
+
/// rather than dropping an MAU-qualifying event over an optional dimension.
|
|
1305
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI8AxeTeams")
|
|
1306
|
+
@interface AxeTeams : NSObject
|
|
1307
|
+
/// Replaces the team memberships stamped on subsequent events, for every client in
|
|
1308
|
+
/// this process.
|
|
1309
|
+
/// Intended for a host app that drives the SDK in-process and owns its own login
|
|
1310
|
+
/// session, which outlives any one SDK session. Call it on every session change,
|
|
1311
|
+
/// including logout, where the correct value is an empty array. An injected empty
|
|
1312
|
+
/// array means “this user has no teams” and is honoured; it does not fall back to
|
|
1313
|
+
/// whatever a login found.
|
|
1314
|
+
/// Shipped on iOS for API parity with Android, where the Analyzer is the caller. No
|
|
1315
|
+
/// in-process iOS host uses it today: everything reaching this SDK arrives through
|
|
1316
|
+
/// Appium, and a fresh session there means a fresh fetch. In <code>axeDevToolsXCUI_noauth</code>,
|
|
1317
|
+
/// which compiles without analytics, nothing reads this value and no events are sent;
|
|
1318
|
+
/// it ships there for API-surface parity only.
|
|
1319
|
+
/// Entries are dropped rather than sent, and the rest of the array still applies, when
|
|
1320
|
+
/// the id is blank, when either field carries control characters, or when either field
|
|
1321
|
+
/// exceeds 256 unicode scalars. Past 100 entries the array is truncated. Every drop is
|
|
1322
|
+
/// logged. A blank <em>name</em> is kept: the id is the identity.
|
|
1323
|
+
/// \param teams The actor’s current team memberships. Pass an empty array to clear.
|
|
1324
|
+
///
|
|
1325
|
+
+ (void)setTeams:(NSArray<AxeTeam *> * _Nonnull)teams;
|
|
1326
|
+
/// Suppresses the <code>init()</code> the <code>@objc</code>/<code>NSObject</code> bridge would otherwise publish on a
|
|
1327
|
+
/// type that is a namespace for static members, matching <code>AxeIntegration</code>.
|
|
1328
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1329
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1330
|
+
@end
|
|
1331
|
+
|
|
1332
|
+
/// The accessibility traits on a view. Similar to UIAccessibilityTraits.
|
|
1333
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeTraits")
|
|
1334
|
+
@interface AxeTraits : NSObject
|
|
1335
|
+
@property (nonatomic) uint64_t rawValue;
|
|
1336
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
1337
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1338
|
+
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
1339
|
+
- (nonnull instancetype)initWithRawValue:(uint64_t)raw OBJC_DESIGNATED_INITIALIZER;
|
|
1340
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1341
|
+
- (void)formUnion:(AxeTraits * _Nonnull)other;
|
|
1342
|
+
- (void)formIntersection:(AxeTraits * _Nonnull)other;
|
|
1343
|
+
- (void)formSymmetricDifference:(AxeTraits * _Nonnull)other;
|
|
1344
|
+
/// Same as UIAccessibilityTraits.adjustable
|
|
1345
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull adjustable;)
|
|
1346
|
+
+ (AxeTraits * _Nonnull)adjustable SWIFT_WARN_UNUSED_RESULT;
|
|
1347
|
+
/// Same as UIAccessibilityTraits.allowsDirectInteraction
|
|
1348
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull allowsDirectInteraction;)
|
|
1349
|
+
+ (AxeTraits * _Nonnull)allowsDirectInteraction SWIFT_WARN_UNUSED_RESULT;
|
|
1350
|
+
/// Same as UIAccessibilityTraits.button
|
|
1351
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull button;)
|
|
1352
|
+
+ (AxeTraits * _Nonnull)button SWIFT_WARN_UNUSED_RESULT;
|
|
1353
|
+
/// Same as UIAccessibilityTraits.causesPageTurn
|
|
1354
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull causesPageTurn;)
|
|
1355
|
+
+ (AxeTraits * _Nonnull)causesPageTurn SWIFT_WARN_UNUSED_RESULT;
|
|
1356
|
+
/// Same as UIAccessibilityTraits.header
|
|
1357
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull header;)
|
|
1358
|
+
+ (AxeTraits * _Nonnull)header SWIFT_WARN_UNUSED_RESULT;
|
|
1359
|
+
/// Same as UIAccessibilityTraits.image
|
|
1360
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull image;)
|
|
1361
|
+
+ (AxeTraits * _Nonnull)image SWIFT_WARN_UNUSED_RESULT;
|
|
1362
|
+
/// Same as UIAccessibilityTraits.keyboardKey
|
|
1363
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull keyboardKey;)
|
|
1364
|
+
+ (AxeTraits * _Nonnull)keyboardKey SWIFT_WARN_UNUSED_RESULT;
|
|
1365
|
+
/// Same as UIAccessibilityTraits.link
|
|
1366
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull link;)
|
|
1367
|
+
+ (AxeTraits * _Nonnull)link SWIFT_WARN_UNUSED_RESULT;
|
|
1368
|
+
/// Same as UIAccessibilityTraits.none
|
|
1369
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull none;)
|
|
1370
|
+
+ (AxeTraits * _Nonnull)none SWIFT_WARN_UNUSED_RESULT;
|
|
1371
|
+
/// Same as UIAccessibilityTraits.notEnabled
|
|
1372
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull notEnabled;)
|
|
1373
|
+
+ (AxeTraits * _Nonnull)notEnabled SWIFT_WARN_UNUSED_RESULT;
|
|
1374
|
+
/// Same as UIAccessibilityTraits.playsSound
|
|
1375
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull playsSound;)
|
|
1376
|
+
+ (AxeTraits * _Nonnull)playsSound SWIFT_WARN_UNUSED_RESULT;
|
|
1377
|
+
/// Same as UIAccessibilityTraits.searchField
|
|
1378
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull searchField;)
|
|
1379
|
+
+ (AxeTraits * _Nonnull)searchField SWIFT_WARN_UNUSED_RESULT;
|
|
1380
|
+
/// Same as UIAccessibilityTraits.selected
|
|
1381
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull selected;)
|
|
1382
|
+
+ (AxeTraits * _Nonnull)selected SWIFT_WARN_UNUSED_RESULT;
|
|
1383
|
+
/// Same as UIAccessibilityTraits.startsMediaSession
|
|
1384
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull startsMediaSession;)
|
|
1385
|
+
+ (AxeTraits * _Nonnull)startsMediaSession SWIFT_WARN_UNUSED_RESULT;
|
|
1386
|
+
/// Same as UIAccessibilityTraits.staticText
|
|
1387
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull staticText;)
|
|
1388
|
+
+ (AxeTraits * _Nonnull)staticText SWIFT_WARN_UNUSED_RESULT;
|
|
1389
|
+
/// Same as UIAccessibilityTraits.summaryElement
|
|
1390
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull summaryElement;)
|
|
1391
|
+
+ (AxeTraits * _Nonnull)summaryElement SWIFT_WARN_UNUSED_RESULT;
|
|
1392
|
+
/// Same as UIAccessibilityTraits.tabBar
|
|
1393
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull tabBar;)
|
|
1394
|
+
+ (AxeTraits * _Nonnull)tabBar SWIFT_WARN_UNUSED_RESULT;
|
|
1395
|
+
/// Same as UIAccessibilityTraits.updatesFrequently
|
|
1396
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull updatesFrequently;)
|
|
1397
|
+
+ (AxeTraits * _Nonnull)updatesFrequently SWIFT_WARN_UNUSED_RESULT;
|
|
1398
|
+
/// Converts an AxeTrait into an easily readable String.
|
|
1399
|
+
///
|
|
1400
|
+
/// returns:
|
|
1401
|
+
/// The name of the AxeTrait. If there are multiple traits within an AxeTraits object, the traits will be in a comma-separated String. For example, <code>(.button | .adjustable).toString()</code> would return <code>Adjustable, Button</code>.
|
|
1402
|
+
- (NSString * _Nonnull)toString SWIFT_WARN_UNUSED_RESULT;
|
|
1403
|
+
@end
|
|
1404
|
+
|
|
1405
|
+
/// Who triggered a scan session, for MAU reporting.
|
|
1406
|
+
/// <code>@objc</code>-bridged so a typo in an Objective-C caller is a build failure, not a silently
|
|
1407
|
+
/// wrong value. Both the <code>Int</code> raw values (the Objective-C bridge exposes them by ordinal)
|
|
1408
|
+
/// and <code>wireValue</code> are published contracts: append only, never renumber or reword.
|
|
1409
|
+
typedef SWIFT_ENUM(NSInteger, AxeUsageActor, open) {
|
|
1410
|
+
AxeUsageActorHuman = 0,
|
|
1411
|
+
AxeUsageActorAutomation = 1,
|
|
1412
|
+
};
|
|
1413
|
+
|
|
1414
|
+
SWIFT_ENUM_FWD_DECL(NSInteger, RunStatus)
|
|
1415
|
+
/// A class representing one view in a view hierarchy.
|
|
1416
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI7AxeView")
|
|
1417
|
+
@interface AxeView : NSObject
|
|
1418
|
+
/// name of the original class, as a String (UIButton, UIWindow, DQButton, etc).
|
|
1419
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull className;
|
|
1420
|
+
/// the type of object. We use this to help determine whether a rule should be run on a specific view. AxeElementTypes are derived from XCUIElement <code>ElementType</code>.
|
|
1421
|
+
@property (nonatomic, readonly) enum AxeElementType elementType;
|
|
1422
|
+
/// the view’s on-screen coordinates, in pixels (not pt).
|
|
1423
|
+
@property (nonatomic, readonly, strong) AxeBounds * _Nonnull boundsInScreen;
|
|
1424
|
+
/// the view’s accessibility identifier.
|
|
1425
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable accessibilityIdentifier;
|
|
1426
|
+
/// the view’s accessible name. This is usually equivalent to the view’s accessibilityLabel or its visible text. Will be <code>nil</code> if the view is not focusable by VoiceOver.
|
|
1427
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable name;
|
|
1428
|
+
/// the type of the view. See <code>AxeRole</code> for more information.
|
|
1429
|
+
@property (nonatomic, readonly) enum AxeRole role;
|
|
1430
|
+
/// the view’s state, if it has one. Will be <code>nil</code> if the view is not a control.
|
|
1431
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable state;
|
|
1432
|
+
/// the view’s value, if it has one. Will be <code>nil</code> if the view does not have a changeable value. Switches, sliders, steppers, etc, all have values.
|
|
1433
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable value;
|
|
1434
|
+
/// whether a view can be directly focused by VoiceOver. This property is calculated from isAccessibilityElement, and will be false for any child views within a VoiceOver-focusable view.
|
|
1435
|
+
@property (nonatomic, readonly) BOOL isAccessibilityFocusable;
|
|
1436
|
+
/// The view’s subviews, as AxeViews
|
|
1437
|
+
@property (nonatomic, readonly, copy) NSArray<AxeView *> * _Nonnull children;
|
|
1438
|
+
/// The view’s parent, as an AxeView.
|
|
1439
|
+
@property (nonatomic, weak) AxeView * _Nullable parent;
|
|
1440
|
+
/// Detected text from the VisionAPI
|
|
1441
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable detectedText;
|
|
1442
|
+
/// a unique identifier for the view. The axeViewId will change between scans of the same view.
|
|
1443
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull axeViewId;
|
|
1444
|
+
/// whether a view can be seen on-screen at the time of the scan. Will return false if the view is off-screen or behind a modal or other views (such as a tab bar or a navigation bar) or if it is partially off-screen.
|
|
1445
|
+
@property (nonatomic, readonly) BOOL isVisibleToUser;
|
|
1446
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1447
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1448
|
+
/// Runs through the view hierarchy in a depth-first search, with the view that this method was called on as the “root” view.
|
|
1449
|
+
/// \param function The function that should be run on the view hierarchy.
|
|
1450
|
+
///
|
|
1451
|
+
///
|
|
1452
|
+
/// returns:
|
|
1453
|
+
/// Whether to continue running through the view hierarchy. See <code>RunStatus</code> for more information.
|
|
1454
|
+
- (enum RunStatus)runOnSelfAndDescendants:(SWIFT_NOESCAPE enum RunStatus (^ _Nonnull)(AxeView * _Nonnull))function;
|
|
1455
|
+
/// Runs through the view hierarchy in a depth-first search, with the view that this method was called on as the “root” view.
|
|
1456
|
+
/// \param function The function that should be run on the view hierarchy.
|
|
1457
|
+
///
|
|
1458
|
+
///
|
|
1459
|
+
/// returns:
|
|
1460
|
+
/// Always returns <code>Stop</code> as the children have finished parsing; See <code>RunStatus</code> for more information.
|
|
1461
|
+
- (enum RunStatus)runOnDescendants:(SWIFT_NOESCAPE enum RunStatus (^ _Nonnull)(AxeView * _Nonnull))function;
|
|
1462
|
+
/// Finds whether the view’s provided property is true or has an ancestor whose provided property is true.
|
|
1463
|
+
/// important:
|
|
1464
|
+
/// <code>propName</code> must be the name of a property that is a <code>Bool</code>. If it is not, this method will log an error into the console and automatically return false.
|
|
1465
|
+
/// \param propName a property that is a <code>Bool</code> that the view or an ancestor of the view may have set to true.
|
|
1466
|
+
///
|
|
1467
|
+
///
|
|
1468
|
+
/// returns:
|
|
1469
|
+
/// true if the view’s property is true or is a child of a view whose provided property is true; false otherwise.
|
|
1470
|
+
- (BOOL)isPropTypeOrChildOfProp:(NSString * _Nonnull)propName SWIFT_WARN_UNUSED_RESULT;
|
|
1471
|
+
/// Finds whether the view has an ancestor whose provided property is true.
|
|
1472
|
+
/// important:
|
|
1473
|
+
/// <code>propName</code> must be the name of a property that is a <code>Bool</code>. If it is not, this method will log an error into the console and automatically return false.
|
|
1474
|
+
/// \param propName a property that is a <code>Bool</code> that an ancestor of the view may have set to true.
|
|
1475
|
+
///
|
|
1476
|
+
///
|
|
1477
|
+
/// returns:
|
|
1478
|
+
/// true if the view is a child of a view whose provided property is true; false otherwise.
|
|
1479
|
+
- (BOOL)isChildOfProp:(NSString * _Nonnull)propName SWIFT_WARN_UNUSED_RESULT;
|
|
1480
|
+
/// Checks whether an ancestor of this view is of the elementType provided.
|
|
1481
|
+
/// \param elementType the type that the ancestor may be.
|
|
1482
|
+
///
|
|
1483
|
+
///
|
|
1484
|
+
/// returns:
|
|
1485
|
+
/// true if the view is a child of the elementType provided, otherwise false.
|
|
1486
|
+
- (BOOL)isChildOfElementType:(enum AxeElementType)elementType SWIFT_WARN_UNUSED_RESULT;
|
|
1487
|
+
/// Finds whether the view is of the elementType provided, or if the view has an ancestor that is of the elementType provided.
|
|
1488
|
+
/// \param elementType the type that the view or an ancestor of the view may be.
|
|
1489
|
+
///
|
|
1490
|
+
///
|
|
1491
|
+
/// returns:
|
|
1492
|
+
/// true if the view is the elementType provided or if it is a child of the elementType provided; false otherwise.
|
|
1493
|
+
- (BOOL)isElementOrChildOfElementType:(enum AxeElementType)elementType SWIFT_WARN_UNUSED_RESULT;
|
|
1494
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1495
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1496
|
+
@end
|
|
1497
|
+
|
|
1498
|
+
/// Attempts to identify the type of app that we are testing against
|
|
1499
|
+
typedef SWIFT_ENUM(NSInteger, AxeViewHierarchy, open) {
|
|
1500
|
+
AxeViewHierarchyUIKit = 0,
|
|
1501
|
+
AxeViewHierarchySwiftUI = 1,
|
|
1502
|
+
AxeViewHierarchyReactNative = 2,
|
|
1503
|
+
AxeViewHierarchyFlutter = 3,
|
|
1504
|
+
};
|
|
1505
|
+
|
|
1506
|
+
/// An object that holds information about the rule, including a brief description, the severity of a failure of the rule, and whether the rule is classified as a WCAG Success Criteria.
|
|
1507
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI8RuleConf")
|
|
1508
|
+
@interface RuleConf : NSObject
|
|
1509
|
+
/// Whether a rule is currently experimental or not.
|
|
1510
|
+
/// Deprecated. This flag does not determine whether a rule runs by default — that is decided by
|
|
1511
|
+
/// each rule’s own <code>ignored</code> default (see <code>AxeConf</code>). <code>InaccessibleAction</code>, the only experimental
|
|
1512
|
+
/// rule, is disabled by default (#2975) independently of this flag. A check on this property
|
|
1513
|
+
/// changes which results you filter, not which rules run. It will be removed in the October 2026 release.
|
|
1514
|
+
@property (nonatomic, readonly) BOOL experimental SWIFT_DEPRECATED_MSG("This flag does not determine whether a rule runs by default; it will be removed in the October 2026 release.");
|
|
1515
|
+
/// A brief description of the rule.
|
|
1516
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull summary;
|
|
1517
|
+
/// The severity of a failure of the rule. See <code>AxeImpact</code> for more information.
|
|
1518
|
+
@property (nonatomic, readonly) enum AxeImpact impact;
|
|
1519
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable ruleId;
|
|
1520
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1521
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1522
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1523
|
+
@end
|
|
1524
|
+
|
|
1525
|
+
/// Whether the view hierarchy should continue to be traversed.
|
|
1526
|
+
typedef SWIFT_ENUM(NSInteger, RunStatus, open) {
|
|
1527
|
+
/// The view hierarchy should continue to be traversed.
|
|
1528
|
+
RunStatusContinue = 0,
|
|
1529
|
+
/// The view hierarchy should no longer be traversed and will immediately stop at this point.
|
|
1530
|
+
RunStatusStop = 1,
|
|
1531
|
+
/// The view hierarchy should continue to be traversed along siblings of this view and their descendants, but should not traverse through child elements of this view.
|
|
1532
|
+
RunStatusSkipDescendants = 2,
|
|
1533
|
+
};
|
|
1534
|
+
|
|
1535
|
+
#endif // defined(__OBJC__)
|
|
1536
|
+
#if __has_attribute(external_source_symbol)
|
|
1537
|
+
# pragma clang attribute pop
|
|
1538
|
+
#endif
|
|
1539
|
+
#if defined(__cplusplus)
|
|
1540
|
+
#endif
|
|
1541
|
+
#pragma clang diagnostic pop
|
|
1542
|
+
#endif
|
|
1543
|
+
|
|
1544
|
+
#elif defined(__x86_64__) && __x86_64__
|
|
1545
|
+
// Generated by Apple Swift version 6.3.3 effective-5.10 (swiftlang-6.3.3.1.3 clang-2100.1.1.101)
|
|
1546
|
+
#ifndef AXEDEVTOOLSXCUI_SWIFT_H
|
|
1547
|
+
#define AXEDEVTOOLSXCUI_SWIFT_H
|
|
1548
|
+
#pragma clang diagnostic push
|
|
1549
|
+
#pragma clang diagnostic ignored "-Wgcc-compat"
|
|
1550
|
+
|
|
1551
|
+
#if !defined(__has_include)
|
|
1552
|
+
# define __has_include(x) 0
|
|
1553
|
+
#endif
|
|
1554
|
+
#if !defined(__has_attribute)
|
|
1555
|
+
# define __has_attribute(x) 0
|
|
1556
|
+
#endif
|
|
1557
|
+
#if !defined(__has_feature)
|
|
1558
|
+
# define __has_feature(x) 0
|
|
1559
|
+
#endif
|
|
1560
|
+
#if !defined(__has_warning)
|
|
1561
|
+
# define __has_warning(x) 0
|
|
1562
|
+
#endif
|
|
1563
|
+
|
|
1564
|
+
#if __has_include(<swift/objc-prologue.h>)
|
|
1565
|
+
# include <swift/objc-prologue.h>
|
|
1566
|
+
#endif
|
|
1567
|
+
|
|
1568
|
+
#pragma clang diagnostic ignored "-Wauto-import"
|
|
1569
|
+
#if defined(__OBJC__)
|
|
1570
|
+
#include <Foundation/Foundation.h>
|
|
1571
|
+
#endif // defined(__OBJC__)
|
|
1572
|
+
#if defined(__cplusplus)
|
|
1573
|
+
#include <cstdint>
|
|
1574
|
+
#include <cstddef>
|
|
1575
|
+
#include <cstdbool>
|
|
1576
|
+
#include <cstring>
|
|
1577
|
+
#include <stdlib.h>
|
|
1578
|
+
#include <new>
|
|
1579
|
+
#include <type_traits>
|
|
1580
|
+
#else
|
|
1581
|
+
#include <stdint.h>
|
|
1582
|
+
#include <stddef.h>
|
|
1583
|
+
#include <stdbool.h>
|
|
1584
|
+
#include <string.h>
|
|
1585
|
+
#endif
|
|
1586
|
+
#if defined(__cplusplus)
|
|
1587
|
+
#pragma clang diagnostic push
|
|
1588
|
+
#pragma clang diagnostic ignored "-Wnon-modular-include-in-framework-module"
|
|
1589
|
+
#if defined(__arm64e__) && __has_include(<ptrauth.h>)
|
|
1590
|
+
# include <ptrauth.h>
|
|
1591
|
+
#else
|
|
1592
|
+
#pragma clang diagnostic push
|
|
1593
|
+
#pragma clang diagnostic ignored "-Wreserved-macro-identifier"
|
|
1594
|
+
# ifndef __ptrauth_swift_value_witness_function_pointer
|
|
1595
|
+
# define __ptrauth_swift_value_witness_function_pointer(x)
|
|
1596
|
+
# endif
|
|
1597
|
+
# ifndef __ptrauth_swift_class_method_pointer
|
|
1598
|
+
# define __ptrauth_swift_class_method_pointer(x)
|
|
1599
|
+
# endif
|
|
1600
|
+
#pragma clang diagnostic pop
|
|
1601
|
+
#endif
|
|
1602
|
+
#pragma clang diagnostic pop
|
|
1603
|
+
#endif
|
|
1604
|
+
|
|
1605
|
+
#if !defined(SWIFT_TYPEDEFS)
|
|
1606
|
+
# define SWIFT_TYPEDEFS 1
|
|
1607
|
+
# if __has_include(<uchar.h>)
|
|
1608
|
+
# include <uchar.h>
|
|
1609
|
+
# elif !defined(__cplusplus)
|
|
1610
|
+
typedef unsigned char char8_t;
|
|
1611
|
+
typedef uint_least16_t char16_t;
|
|
1612
|
+
typedef uint_least32_t char32_t;
|
|
1613
|
+
# endif
|
|
1614
|
+
typedef float swift_float2 __attribute__((__ext_vector_type__(2)));
|
|
1615
|
+
typedef float swift_float3 __attribute__((__ext_vector_type__(3)));
|
|
1616
|
+
typedef float swift_float4 __attribute__((__ext_vector_type__(4)));
|
|
1617
|
+
typedef double swift_double2 __attribute__((__ext_vector_type__(2)));
|
|
1618
|
+
typedef double swift_double3 __attribute__((__ext_vector_type__(3)));
|
|
1619
|
+
typedef double swift_double4 __attribute__((__ext_vector_type__(4)));
|
|
1620
|
+
typedef int swift_int2 __attribute__((__ext_vector_type__(2)));
|
|
1621
|
+
typedef int swift_int3 __attribute__((__ext_vector_type__(3)));
|
|
1622
|
+
typedef int swift_int4 __attribute__((__ext_vector_type__(4)));
|
|
1623
|
+
typedef unsigned int swift_uint2 __attribute__((__ext_vector_type__(2)));
|
|
1624
|
+
typedef unsigned int swift_uint3 __attribute__((__ext_vector_type__(3)));
|
|
1625
|
+
typedef unsigned int swift_uint4 __attribute__((__ext_vector_type__(4)));
|
|
1626
|
+
#endif
|
|
1627
|
+
|
|
1628
|
+
#if !defined(SWIFT_PASTE)
|
|
1629
|
+
# define SWIFT_PASTE_HELPER(x, y) x##y
|
|
1630
|
+
# define SWIFT_PASTE(x, y) SWIFT_PASTE_HELPER(x, y)
|
|
1631
|
+
#endif
|
|
1632
|
+
#if !defined(SWIFT_METATYPE)
|
|
1633
|
+
# define SWIFT_METATYPE(X) Class
|
|
1634
|
+
#endif
|
|
1635
|
+
#if !defined(SWIFT_CLASS_PROPERTY)
|
|
1636
|
+
# if __has_feature(objc_class_property)
|
|
1637
|
+
# define SWIFT_CLASS_PROPERTY(...) __VA_ARGS__
|
|
1638
|
+
# else
|
|
1639
|
+
# define SWIFT_CLASS_PROPERTY(...)
|
|
1640
|
+
# endif
|
|
1641
|
+
#endif
|
|
1642
|
+
#if !defined(SWIFT_RUNTIME_NAME)
|
|
1643
|
+
# if __has_attribute(objc_runtime_name)
|
|
1644
|
+
# define SWIFT_RUNTIME_NAME(X) __attribute__((objc_runtime_name(X)))
|
|
1645
|
+
# else
|
|
1646
|
+
# define SWIFT_RUNTIME_NAME(X)
|
|
1647
|
+
# endif
|
|
1648
|
+
#endif
|
|
1649
|
+
#if !defined(SWIFT_COMPILE_NAME)
|
|
1650
|
+
# if __has_attribute(swift_name)
|
|
1651
|
+
# define SWIFT_COMPILE_NAME(X) __attribute__((swift_name(X)))
|
|
1652
|
+
# else
|
|
1653
|
+
# define SWIFT_COMPILE_NAME(X)
|
|
1654
|
+
# endif
|
|
1655
|
+
#endif
|
|
1656
|
+
#if !defined(SWIFT_METHOD_FAMILY)
|
|
1657
|
+
# if __has_attribute(objc_method_family)
|
|
1658
|
+
# define SWIFT_METHOD_FAMILY(X) __attribute__((objc_method_family(X)))
|
|
1659
|
+
# else
|
|
1660
|
+
# define SWIFT_METHOD_FAMILY(X)
|
|
1661
|
+
# endif
|
|
1662
|
+
#endif
|
|
1663
|
+
#if !defined(SWIFT_NOESCAPE)
|
|
1664
|
+
# if __has_attribute(noescape)
|
|
1665
|
+
# define SWIFT_NOESCAPE __attribute__((noescape))
|
|
1666
|
+
# else
|
|
1667
|
+
# define SWIFT_NOESCAPE
|
|
1668
|
+
# endif
|
|
1669
|
+
#endif
|
|
1670
|
+
#if !defined(SWIFT_RELEASES_ARGUMENT)
|
|
1671
|
+
# if __has_attribute(ns_consumed)
|
|
1672
|
+
# define SWIFT_RELEASES_ARGUMENT __attribute__((ns_consumed))
|
|
1673
|
+
# else
|
|
1674
|
+
# define SWIFT_RELEASES_ARGUMENT
|
|
1675
|
+
# endif
|
|
1676
|
+
#endif
|
|
1677
|
+
#if !defined(SWIFT_WARN_UNUSED_RESULT)
|
|
1678
|
+
# if __has_attribute(warn_unused_result)
|
|
1679
|
+
# define SWIFT_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
|
|
1680
|
+
# else
|
|
1681
|
+
# define SWIFT_WARN_UNUSED_RESULT
|
|
1682
|
+
# endif
|
|
1683
|
+
#endif
|
|
1684
|
+
#if !defined(SWIFT_NORETURN)
|
|
1685
|
+
# if __has_attribute(noreturn)
|
|
1686
|
+
# define SWIFT_NORETURN __attribute__((noreturn))
|
|
1687
|
+
# else
|
|
1688
|
+
# define SWIFT_NORETURN
|
|
1689
|
+
# endif
|
|
1690
|
+
#endif
|
|
1691
|
+
#if !defined(SWIFT_CLASS_EXTRA)
|
|
1692
|
+
# define SWIFT_CLASS_EXTRA
|
|
1693
|
+
#endif
|
|
1694
|
+
#if !defined(SWIFT_PROTOCOL_EXTRA)
|
|
1695
|
+
# define SWIFT_PROTOCOL_EXTRA
|
|
1696
|
+
#endif
|
|
1697
|
+
#if !defined(SWIFT_ENUM_EXTRA)
|
|
1698
|
+
# define SWIFT_ENUM_EXTRA
|
|
1699
|
+
#endif
|
|
1700
|
+
#if !defined(SWIFT_CLASS)
|
|
1701
|
+
# if __has_attribute(objc_subclassing_restricted)
|
|
1702
|
+
# define SWIFT_CLASS(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) __attribute__((objc_subclassing_restricted)) SWIFT_CLASS_EXTRA
|
|
1703
|
+
# define SWIFT_CLASS_NAMED(SWIFT_NAME) __attribute__((objc_subclassing_restricted)) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
|
|
1704
|
+
# else
|
|
1705
|
+
# define SWIFT_CLASS(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
|
|
1706
|
+
# define SWIFT_CLASS_NAMED(SWIFT_NAME) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
|
|
1707
|
+
# endif
|
|
1708
|
+
#endif
|
|
1709
|
+
#if !defined(SWIFT_RESILIENT_CLASS)
|
|
1710
|
+
# if __has_attribute(objc_class_stub)
|
|
1711
|
+
# define SWIFT_RESILIENT_CLASS(SWIFT_NAME) SWIFT_CLASS(SWIFT_NAME) __attribute__((objc_class_stub))
|
|
1712
|
+
# define SWIFT_RESILIENT_CLASS_NAMED(SWIFT_NAME) __attribute__((objc_class_stub)) SWIFT_CLASS_NAMED(SWIFT_NAME)
|
|
1713
|
+
# else
|
|
1714
|
+
# define SWIFT_RESILIENT_CLASS(SWIFT_NAME) SWIFT_CLASS(SWIFT_NAME)
|
|
1715
|
+
# define SWIFT_RESILIENT_CLASS_NAMED(SWIFT_NAME) SWIFT_CLASS_NAMED(SWIFT_NAME)
|
|
1716
|
+
# endif
|
|
1717
|
+
#endif
|
|
1718
|
+
#if !defined(SWIFT_PROTOCOL)
|
|
1719
|
+
# define SWIFT_PROTOCOL(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) SWIFT_PROTOCOL_EXTRA
|
|
1720
|
+
# define SWIFT_PROTOCOL_NAMED(SWIFT_NAME) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_PROTOCOL_EXTRA
|
|
1721
|
+
#endif
|
|
1722
|
+
#if !defined(SWIFT_EXTENSION)
|
|
1723
|
+
# define SWIFT_EXTENSION(M) SWIFT_PASTE(M##_Swift_, __LINE__)
|
|
1724
|
+
#endif
|
|
1725
|
+
#if !defined(OBJC_DESIGNATED_INITIALIZER)
|
|
1726
|
+
# if __has_attribute(objc_designated_initializer)
|
|
1727
|
+
# define OBJC_DESIGNATED_INITIALIZER __attribute__((objc_designated_initializer))
|
|
1728
|
+
# else
|
|
1729
|
+
# define OBJC_DESIGNATED_INITIALIZER
|
|
1730
|
+
# endif
|
|
1731
|
+
#endif
|
|
1732
|
+
#if !defined(SWIFT_ENUM_ATTR)
|
|
1733
|
+
# if __has_attribute(enum_extensibility)
|
|
1734
|
+
# define SWIFT_ENUM_ATTR(_extensibility) __attribute__((enum_extensibility(_extensibility)))
|
|
1735
|
+
# else
|
|
1736
|
+
# define SWIFT_ENUM_ATTR(_extensibility)
|
|
1737
|
+
# endif
|
|
1738
|
+
#endif
|
|
1739
|
+
#if !defined(SWIFT_ENUM)
|
|
1740
|
+
# if (defined(__cplusplus) && __cplusplus >= 201103L) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) || __has_feature(objc_fixed_enum)
|
|
1741
|
+
# define SWIFT_ENUM(_type, _name, _extensibility) enum _name : _type _name; enum SWIFT_ENUM_ATTR(_extensibility) SWIFT_ENUM_EXTRA _name : _type
|
|
1742
|
+
# if __has_feature(generalized_swift_name)
|
|
1743
|
+
# define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME, _extensibility) enum _name : _type _name SWIFT_COMPILE_NAME(SWIFT_NAME); enum SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_ENUM_ATTR(_extensibility) SWIFT_ENUM_EXTRA _name : _type
|
|
1744
|
+
# else
|
|
1745
|
+
# define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME, _extensibility) SWIFT_ENUM(_type, _name, _extensibility)
|
|
1746
|
+
# endif
|
|
1747
|
+
# else
|
|
1748
|
+
# define SWIFT_ENUM(_type, _name, _extensibility) _type _name; enum
|
|
1749
|
+
# define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME, _extensibility) SWIFT_ENUM(_type, _name, _extensibility)
|
|
1750
|
+
# endif
|
|
1751
|
+
#endif
|
|
1752
|
+
#if !defined(SWIFT_ENUM_TAG)
|
|
1753
|
+
# if (defined(__cplusplus) && __cplusplus >= 201103L) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) || __has_feature(objc_fixed_enum)
|
|
1754
|
+
# define SWIFT_ENUM_TAG enum
|
|
1755
|
+
# else
|
|
1756
|
+
# define SWIFT_ENUM_TAG
|
|
1757
|
+
# endif
|
|
1758
|
+
#endif
|
|
1759
|
+
#if !defined(SWIFT_ENUM_FWD_DECL)
|
|
1760
|
+
# if (defined(__cplusplus) && __cplusplus >= 201103L) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) || __has_feature(objc_fixed_enum)
|
|
1761
|
+
# define SWIFT_ENUM_FWD_DECL(_type, _name) enum _name : _type;
|
|
1762
|
+
# else
|
|
1763
|
+
# define SWIFT_ENUM_FWD_DECL(_type, _name) typedef _type _name;
|
|
1764
|
+
# endif
|
|
1765
|
+
#endif
|
|
1766
|
+
#if !defined(SWIFT_UNAVAILABLE)
|
|
1767
|
+
# define SWIFT_UNAVAILABLE __attribute__((unavailable))
|
|
1768
|
+
#endif
|
|
1769
|
+
#if !defined(SWIFT_UNAVAILABLE_MSG)
|
|
1770
|
+
# define SWIFT_UNAVAILABLE_MSG(msg) __attribute__((unavailable(msg)))
|
|
1771
|
+
#endif
|
|
1772
|
+
#if !defined(SWIFT_AVAILABILITY)
|
|
1773
|
+
# define SWIFT_AVAILABILITY(plat, ...) __attribute__((availability(plat, __VA_ARGS__)))
|
|
1774
|
+
#endif
|
|
1775
|
+
#if !defined(SWIFT_AVAILABILITY_DOMAIN)
|
|
1776
|
+
# define SWIFT_AVAILABILITY_DOMAIN(dom, ...) __attribute__((availability(domain: dom, __VA_ARGS__)))
|
|
1777
|
+
#endif
|
|
1778
|
+
#if !defined(SWIFT_WEAK_IMPORT)
|
|
1779
|
+
# define SWIFT_WEAK_IMPORT __attribute__((weak_import))
|
|
1780
|
+
#endif
|
|
1781
|
+
#if !defined(SWIFT_DEPRECATED)
|
|
1782
|
+
# define SWIFT_DEPRECATED __attribute__((deprecated))
|
|
1783
|
+
#endif
|
|
1784
|
+
#if !defined(SWIFT_DEPRECATED_MSG)
|
|
1785
|
+
# define SWIFT_DEPRECATED_MSG(...) __attribute__((deprecated(__VA_ARGS__)))
|
|
1786
|
+
#endif
|
|
1787
|
+
#if !defined(SWIFT_DEPRECATED_OBJC)
|
|
1788
|
+
# if __has_feature(attribute_diagnose_if_objc)
|
|
1789
|
+
# define SWIFT_DEPRECATED_OBJC(Msg) __attribute__((diagnose_if(1, Msg, "warning")))
|
|
1790
|
+
# else
|
|
1791
|
+
# define SWIFT_DEPRECATED_OBJC(Msg) SWIFT_DEPRECATED_MSG(Msg)
|
|
1792
|
+
# endif
|
|
1793
|
+
#endif
|
|
1794
|
+
#if defined(__OBJC__)
|
|
1795
|
+
#if !defined(IBSegueAction)
|
|
1796
|
+
# define IBSegueAction
|
|
1797
|
+
#endif
|
|
1798
|
+
#endif
|
|
1799
|
+
#if !defined(SWIFT_EXTERN)
|
|
1800
|
+
# if defined(__cplusplus)
|
|
1801
|
+
# define SWIFT_EXTERN extern "C"
|
|
1802
|
+
# else
|
|
1803
|
+
# define SWIFT_EXTERN extern
|
|
1804
|
+
# endif
|
|
1805
|
+
#endif
|
|
1806
|
+
#if !defined(SWIFT_CALL)
|
|
1807
|
+
# define SWIFT_CALL __attribute__((swiftcall))
|
|
1808
|
+
#endif
|
|
1809
|
+
#if !defined(SWIFT_INDIRECT_RESULT)
|
|
1810
|
+
# define SWIFT_INDIRECT_RESULT __attribute__((swift_indirect_result))
|
|
1811
|
+
#endif
|
|
1812
|
+
#if !defined(SWIFT_CONTEXT)
|
|
1813
|
+
# define SWIFT_CONTEXT __attribute__((swift_context))
|
|
1814
|
+
#endif
|
|
1815
|
+
#if !defined(SWIFT_ERROR_RESULT)
|
|
1816
|
+
# define SWIFT_ERROR_RESULT __attribute__((swift_error_result))
|
|
1817
|
+
#endif
|
|
1818
|
+
#if defined(__cplusplus)
|
|
1819
|
+
# define SWIFT_NOEXCEPT noexcept
|
|
1820
|
+
#else
|
|
1821
|
+
# define SWIFT_NOEXCEPT
|
|
1822
|
+
#endif
|
|
1823
|
+
#if !defined(SWIFT_C_INLINE_THUNK)
|
|
1824
|
+
# if __has_attribute(always_inline)
|
|
1825
|
+
# if __has_attribute(nodebug)
|
|
1826
|
+
# define SWIFT_C_INLINE_THUNK inline __attribute__((always_inline)) __attribute__((nodebug))
|
|
1827
|
+
# else
|
|
1828
|
+
# define SWIFT_C_INLINE_THUNK inline __attribute__((always_inline))
|
|
1829
|
+
# endif
|
|
1830
|
+
# else
|
|
1831
|
+
# define SWIFT_C_INLINE_THUNK inline
|
|
1832
|
+
# endif
|
|
1833
|
+
#endif
|
|
1834
|
+
#if defined(_WIN32)
|
|
1835
|
+
#if !defined(SWIFT_IMPORT_STDLIB_SYMBOL)
|
|
1836
|
+
# define SWIFT_IMPORT_STDLIB_SYMBOL __declspec(dllimport)
|
|
1837
|
+
#endif
|
|
1838
|
+
#else
|
|
1839
|
+
#if !defined(SWIFT_IMPORT_STDLIB_SYMBOL)
|
|
1840
|
+
# define SWIFT_IMPORT_STDLIB_SYMBOL
|
|
1841
|
+
#endif
|
|
1842
|
+
#endif
|
|
1843
|
+
#if !__has_feature(nullability)
|
|
1844
|
+
# define _Nonnull
|
|
1845
|
+
# define _Nullable
|
|
1846
|
+
# define _Null_unspecified
|
|
1847
|
+
#elif !defined(__OBJC__)
|
|
1848
|
+
# pragma clang diagnostic ignored "-Wnullability-extension"
|
|
1849
|
+
#endif
|
|
1850
|
+
#if !__has_feature(nullability_nullable_result)
|
|
1851
|
+
# define _Nullable_result _Nullable
|
|
1852
|
+
#endif
|
|
1853
|
+
#if __has_feature(objc_modules)
|
|
1854
|
+
#if __has_warning("-Watimport-in-framework-header")
|
|
1855
|
+
#pragma clang diagnostic ignored "-Watimport-in-framework-header"
|
|
1856
|
+
#endif
|
|
1857
|
+
#endif
|
|
1858
|
+
|
|
1859
|
+
#pragma clang diagnostic ignored "-Wproperty-attribute-mismatch"
|
|
1860
|
+
#pragma clang diagnostic ignored "-Wduplicate-method-arg"
|
|
1861
|
+
#if __has_warning("-Wpragma-clang-attribute")
|
|
1862
|
+
# pragma clang diagnostic ignored "-Wpragma-clang-attribute"
|
|
1863
|
+
#endif
|
|
1864
|
+
#pragma clang diagnostic ignored "-Wunknown-pragmas"
|
|
1865
|
+
#pragma clang diagnostic ignored "-Wnullability"
|
|
1866
|
+
#pragma clang diagnostic ignored "-Wdollar-in-identifier-extension"
|
|
1867
|
+
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
|
|
1868
|
+
|
|
1869
|
+
#if __has_attribute(external_source_symbol)
|
|
1870
|
+
# pragma push_macro("any")
|
|
1871
|
+
# undef any
|
|
1872
|
+
# pragma clang attribute push(__attribute__((external_source_symbol(language="Swift", defined_in="axeDevToolsXCUI",generated_declaration))), apply_to=any(function,enum,objc_interface,objc_category,objc_protocol))
|
|
1873
|
+
# pragma pop_macro("any")
|
|
1874
|
+
#endif
|
|
1875
|
+
|
|
1876
|
+
#if defined(__cplusplus)
|
|
1877
|
+
extern "C" {
|
|
1878
|
+
#endif
|
|
1879
|
+
|
|
1880
|
+
#if defined(__cplusplus)
|
|
1881
|
+
} // extern "C"
|
|
1882
|
+
#endif
|
|
1883
|
+
#if __has_attribute(external_source_symbol)
|
|
1884
|
+
# pragma clang attribute pop
|
|
1885
|
+
#endif
|
|
1886
|
+
#if defined(__OBJC__)
|
|
1887
|
+
#if __has_feature(objc_modules)
|
|
1888
|
+
#if __has_warning("-Watimport-in-framework-header")
|
|
1889
|
+
#pragma clang diagnostic ignored "-Watimport-in-framework-header"
|
|
1890
|
+
#endif
|
|
1891
|
+
@import Foundation;
|
|
1892
|
+
@import ObjectiveC;
|
|
1893
|
+
#endif
|
|
1894
|
+
|
|
1895
|
+
#endif // defined(__OBJC__)
|
|
1896
|
+
#pragma clang diagnostic ignored "-Wproperty-attribute-mismatch"
|
|
1897
|
+
#pragma clang diagnostic ignored "-Wduplicate-method-arg"
|
|
1898
|
+
#if __has_warning("-Wpragma-clang-attribute")
|
|
1899
|
+
# pragma clang diagnostic ignored "-Wpragma-clang-attribute"
|
|
1900
|
+
#endif
|
|
1901
|
+
#pragma clang diagnostic ignored "-Wunknown-pragmas"
|
|
1902
|
+
#pragma clang diagnostic ignored "-Wnullability"
|
|
1903
|
+
#pragma clang diagnostic ignored "-Wdollar-in-identifier-extension"
|
|
1904
|
+
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
|
|
1905
|
+
|
|
1906
|
+
#if __has_attribute(external_source_symbol)
|
|
1907
|
+
# pragma push_macro("any")
|
|
1908
|
+
# undef any
|
|
1909
|
+
# pragma clang attribute push(__attribute__((external_source_symbol(language="Swift", defined_in="axeDevToolsXCUI",generated_declaration))), apply_to=any(function,enum,objc_interface,objc_category,objc_protocol))
|
|
1910
|
+
# pragma pop_macro("any")
|
|
1911
|
+
#endif
|
|
1912
|
+
|
|
1913
|
+
#if defined(__OBJC__)
|
|
1914
|
+
|
|
1915
|
+
@class NSString;
|
|
1916
|
+
@class NSBundle;
|
|
1917
|
+
@class NSDictionary;
|
|
1918
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI15AutoScanManager")
|
|
1919
|
+
@interface AutoScanManager : NSObject
|
|
1920
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AutoScanManager * _Nonnull shared;)
|
|
1921
|
+
+ (AutoScanManager * _Nonnull)shared SWIFT_WARN_UNUSED_RESULT;
|
|
1922
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1923
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1924
|
+
- (BOOL)enableWithBundleId:(NSString * _Nonnull)bundleId apiKey:(NSString * _Nonnull)apiKey axeServiceUrl:(NSString * _Nonnull)axeServiceUrl axeAccountUrl:(NSString * _Nonnull)axeAccountUrl projectId:(NSString * _Nonnull)projectId uploadToDashboard:(BOOL)uploadToDashboard htmlReportPath:(NSString * _Nullable)htmlReportPath error:(NSError * _Nullable * _Nullable)error;
|
|
1925
|
+
/// Captures the current screen state without requiring a gesture trigger.
|
|
1926
|
+
/// Called from WDA after enable() to capture the initial screen.
|
|
1927
|
+
- (void)captureInitialContext;
|
|
1928
|
+
- (void)startWith:(NSBundle * _Nullable)testBundle;
|
|
1929
|
+
- (NSDictionary * _Nonnull)runScansAndReport;
|
|
1930
|
+
@end
|
|
1931
|
+
|
|
1932
|
+
/// Auto Scan control surface for Appium/WebDriverAgent.
|
|
1933
|
+
/// Mirrors Android’s <code>AxeAppium</code> (<code>pauseAutoScan()</code> / <code>resumeAutoScan()</code>) so the downstream
|
|
1934
|
+
/// Appium integration is call-site identical across platforms. Not intended for direct
|
|
1935
|
+
/// in-test use — test authors should prefer <code>AxeAutoScan.skipScan { }</code>, which cannot be
|
|
1936
|
+
/// left dangling.
|
|
1937
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeAppium")
|
|
1938
|
+
@interface AxeAppium : NSObject
|
|
1939
|
+
/// Creates a control surface bound to the live Auto Scan session (<code>AutoScanManager.shared</code>).
|
|
1940
|
+
- (nonnull instancetype)init;
|
|
1941
|
+
/// Pauses Auto Scan capture. Gestures still execute normally; their screens are not captured.
|
|
1942
|
+
/// Idempotent: calling while already paused is a no-op. Always pair with <code>resumeAutoScan()</code>.
|
|
1943
|
+
- (void)pauseAutoScan;
|
|
1944
|
+
/// Resumes Auto Scan capture after a pause.
|
|
1945
|
+
/// Idempotent: calling while not paused is a no-op.
|
|
1946
|
+
- (void)resumeAutoScan;
|
|
1947
|
+
@end
|
|
1948
|
+
|
|
1949
|
+
/// Customer-facing entry point for excluding interactions from Auto Scan.
|
|
1950
|
+
/// Auto Scan is enabled the usual way (via <code>axe_config.json</code>); this API only adjusts capture
|
|
1951
|
+
/// behavior while a run is already in progress. Matches Android’s static
|
|
1952
|
+
/// <code>AxeAutoScan.skipScan { }</code> so cross-platform call sites are identical.
|
|
1953
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI11AxeAutoScan")
|
|
1954
|
+
@interface AxeAutoScan : NSObject
|
|
1955
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1956
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1957
|
+
@end
|
|
1958
|
+
|
|
1959
|
+
/// A class that contains the location and dimensions of a rectangle, in iOS points.
|
|
1960
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI7AxeRect")
|
|
1961
|
+
@interface AxeRect : NSObject
|
|
1962
|
+
/// The left-most bounds of the frame, in pts. Equal to CGRect <code>minX</code> property.
|
|
1963
|
+
@property (nonatomic, readonly) float left;
|
|
1964
|
+
/// The right-most bounds of the frame, in pts.
|
|
1965
|
+
@property (nonatomic, readonly) float right;
|
|
1966
|
+
/// The top-most bounds of the frame, in pts. Equal to CGRect <code>minY</code> property.
|
|
1967
|
+
@property (nonatomic, readonly) float top;
|
|
1968
|
+
/// The bottom-most bounds of the frame, in pts.
|
|
1969
|
+
@property (nonatomic, readonly) float bottom;
|
|
1970
|
+
/// The height of the frame, in pts. Equal to <code>bottom - top</code>.
|
|
1971
|
+
@property (nonatomic, readonly) float height;
|
|
1972
|
+
/// The width of the frame, in pts. Equal to <code>right - left</code>.
|
|
1973
|
+
@property (nonatomic, readonly) float width;
|
|
1974
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1975
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
1976
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1977
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1978
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1979
|
+
@end
|
|
1980
|
+
|
|
1981
|
+
/// A class that contains the location and dimensions of a rectangle, in on-screen pixels.
|
|
1982
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeBounds")
|
|
1983
|
+
@interface AxeBounds : AxeRect
|
|
1984
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1985
|
+
@end
|
|
1986
|
+
|
|
1987
|
+
/// The configuration for an axeDevTools object.
|
|
1988
|
+
/// By default, all <code>AxeRule</code>s will run, with the exception of <code>InaccessibleAction</code>, which is disabled by default (see <code>AxeRuleId.InaccessibleAction</code>, deprecated ahead of removal in the October 2026 release). You can use this object to ignore rules, or add custom rules that you define.
|
|
1989
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI7AxeConf")
|
|
1990
|
+
@interface AxeConf : NSObject
|
|
1991
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1992
|
+
/// Creates a new <code>AxeConf</code> object. All rules are added by default. See <code>AxeRuleId</code> for a full list of available rules.
|
|
1993
|
+
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
1994
|
+
/// This method allows you to ignore (or re-introduce) results from any rule, including custom rules. By default, no rules (including custom rules) are ignored, with the exception of <code>InaccessibleAction</code>, which is ignored by default.
|
|
1995
|
+
/// Deprecated. This API changes shape in the October 2026 release (#3074); see the release
|
|
1996
|
+
/// migration note. Behavior is unchanged until then.
|
|
1997
|
+
/// \param rule the rule’s <code>AxeRuleId</code> (or a custom rule’s class name) whose results should be ignored (or included), as a String.
|
|
1998
|
+
///
|
|
1999
|
+
/// \param shouldIgnore a <code>Bool</code> indicating whether the rule’s results should be ignored. Set to <code>true</code> if the rule’s results should be ignored, or <code>false</code> if the rule’s results should be included. Default value is <code>true</code>.
|
|
2000
|
+
///
|
|
2001
|
+
- (void)ignoreWithRule:(NSString * _Nonnull)rule :(BOOL)shouldIgnore SWIFT_DEPRECATED_MSG("Deprecated ahead of a shape change in the October 2026 release; see the release migration note. Behavior is unchanged until then.");
|
|
2002
|
+
/// This method allows you to ignore (or re-introduce) results from any rule, including custom rules. By default, no rules (including custom rules) are ignored, with the exception of <code>InaccessibleAction</code>, which is ignored by default.
|
|
2003
|
+
/// Deprecated. This API changes shape in the October 2026 release (#3074); see the release
|
|
2004
|
+
/// migration note. Behavior is unchanged until then.
|
|
2005
|
+
/// \param rules the <code>AxeRuleId</code>s (or classNames, for custom rules) of the rules you wish to ignore, as a <code>String</code>.
|
|
2006
|
+
///
|
|
2007
|
+
/// \param shouldIgnore a <code>Bool</code> indicating whether the set of rules should have their results ignored. Set to <code>true</code> if they should be ignored or <code>false</code> if they should be included. Default value is <code>true</code>.
|
|
2008
|
+
///
|
|
2009
|
+
- (void)ignoreWithRules:(NSArray<NSString *> * _Nonnull)rules :(BOOL)shouldIgnore SWIFT_DEPRECATED_MSG("Deprecated ahead of a shape change in the October 2026 release; see the release migration note. Behavior is unchanged until then.");
|
|
2010
|
+
/// This method allows you to ignore all experimental rules. <code>InaccessibleAction</code>, the only
|
|
2011
|
+
/// experimental rule, is already ignored by default (#2975), so this call is a no-op unless a
|
|
2012
|
+
/// caller previously opted it back in.
|
|
2013
|
+
/// Deprecated. Experimental rules are being retired and this method will be removed in the
|
|
2014
|
+
/// October 2026 release (#3002). To keep a specific rule off, use <code>ignore(rule:)</code>, which is
|
|
2015
|
+
/// itself deprecated ahead of a shape change in that same release (#3074).
|
|
2016
|
+
- (void)ignoreExperimental SWIFT_DEPRECATED_MSG("Experimental rules are being retired and this method will be removed in the October 2026 release. To keep a rule off, use ignore(rule:); it is itself deprecated ahead of a shape change in that same release.");
|
|
2017
|
+
/// Ignore specific rules for specific views, as defined in the provided dictionary, by Class or Accessibility Identifier.
|
|
2018
|
+
/// Classes that inherit from a classname specified here will not be ignored. For example, if you specify that the rule <code>InScrollView</code> should not run on any <code>UILabel</code>, <code>InScrollView</code> will still run on the class <code>DQLabel</code> (which inherits from <code>UILabel</code>).
|
|
2019
|
+
/// Deprecated. This API changes shape in the October 2026 release (#3074); see the release
|
|
2020
|
+
/// migration note. Behavior is unchanged until then.
|
|
2021
|
+
/// *
|
|
2022
|
+
/// \param rulesFor A dictionary where each key, the Class name or Accessibility Identifier of a view, has a <code>Set</code> of <code>Strings</code> containing Rule Id’s to ignore.
|
|
2023
|
+
///
|
|
2024
|
+
- (void)ignoreWithRulesFor:(NSDictionary<NSString *, NSSet<NSString *> *> * _Nonnull)rulesFor SWIFT_DEPRECATED_MSG("Deprecated ahead of a shape change in the October 2026 release; see the release migration note. Behavior is unchanged until then.");
|
|
2025
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2026
|
+
@end
|
|
2027
|
+
|
|
2028
|
+
@class AxeView;
|
|
2029
|
+
@class AxeDevice;
|
|
2030
|
+
@class AxeImage;
|
|
2031
|
+
@class AxeMetaData;
|
|
2032
|
+
/// Lives within AxeResult and contains meta data about the scan, device information, the screenshot, and the view hierarchy.
|
|
2033
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI10AxeContext")
|
|
2034
|
+
@interface AxeContext : NSObject
|
|
2035
|
+
/// The view hierarchy of the scanned view.
|
|
2036
|
+
@property (nonatomic, readonly, strong) AxeView * _Nonnull axeView;
|
|
2037
|
+
/// Information about the device used for the scan.
|
|
2038
|
+
@property (nonatomic, readonly, strong) AxeDevice * _Nonnull axeDevice;
|
|
2039
|
+
/// A screenshot of the view that was scanned.
|
|
2040
|
+
@property (nonatomic, readonly, strong) AxeImage * _Nonnull screenshot;
|
|
2041
|
+
/// Additional meta data.
|
|
2042
|
+
@property (nonatomic, strong) AxeMetaData * _Nonnull axeMetaData;
|
|
2043
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2044
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2045
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2046
|
+
@end
|
|
2047
|
+
|
|
2048
|
+
@class AxeDevToolsResultKey;
|
|
2049
|
+
@class AxeResult;
|
|
2050
|
+
/// AxeDevTools class contains many static methods for you to set up testing for accessibility.
|
|
2051
|
+
/// With this class, you can:
|
|
2052
|
+
/// <ul>
|
|
2053
|
+
/// <li>
|
|
2054
|
+
/// set up an automated accessibility test for either an entire screen or a single view
|
|
2055
|
+
/// </li>
|
|
2056
|
+
/// <li>
|
|
2057
|
+
/// add the floating action button to your application to scan the current screen’s contents for accessibility issues when pressed
|
|
2058
|
+
/// </li>
|
|
2059
|
+
/// <li>
|
|
2060
|
+
/// configure your accessibility tests to suit your needs
|
|
2061
|
+
/// </li>
|
|
2062
|
+
/// </ul>
|
|
2063
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI11AxeDevTools")
|
|
2064
|
+
@interface AxeDevTools : NSObject
|
|
2065
|
+
/// Set this property if you want to change which rules are run or if you want to add custom rules.
|
|
2066
|
+
/// Deprecated. Ignoring rules and adding custom rules are moving directly onto <code>AxeDevTools</code>.
|
|
2067
|
+
/// This property will be removed after the October 2026 release, once the replacement ships —
|
|
2068
|
+
/// there is nothing to migrate to yet, so it continues to work exactly as it does today until then.
|
|
2069
|
+
@property (nonatomic, strong) AxeConf * _Nonnull configuration SWIFT_DEPRECATED_MSG("Rule ignoring and custom rules are moving directly onto AxeDevTools. This property will be removed after the October 2026 release, once the replacement ships. No migration is possible yet; behavior is unchanged until then.");
|
|
2070
|
+
/// Set this property to <code>true</code> if you want additional debug information for unexpected behavior.
|
|
2071
|
+
/// We may request this to be turned on if an obscure bug is found.
|
|
2072
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
2073
|
+
+ (BOOL)debugStatements SWIFT_WARN_UNUSED_RESULT;
|
|
2074
|
+
+ (void)setDebugStatements:(BOOL)value;
|
|
2075
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable sessionId;
|
|
2076
|
+
/// Retrieves the scan from the server. This can be used within UITests to assert things about a scan that was pushed to the server, such as the number of accessibility issues within a scan. Will throw an error if there was an issue retrieving the scan.
|
|
2077
|
+
/// \param resultKey The AxeDevToolsResultKey of the scan you would like to retrieve from the server.
|
|
2078
|
+
///
|
|
2079
|
+
///
|
|
2080
|
+
/// returns:
|
|
2081
|
+
/// The scan from the server.
|
|
2082
|
+
- (AxeResult * _Nullable)getResult:(AxeDevToolsResultKey * _Nonnull)resultKey error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned.");
|
|
2083
|
+
/// Use this after calling <code>run</code> to send the scan to the server. Will throw an error if sending the scan was not successful.
|
|
2084
|
+
/// \param result The result that should be pushed to the dashboard.
|
|
2085
|
+
///
|
|
2086
|
+
/// \param scanName A String to change the scan name to in the dashboard.
|
|
2087
|
+
///
|
|
2088
|
+
///
|
|
2089
|
+
/// returns:
|
|
2090
|
+
/// AxeDevToolsResultKey. This type is deprecated and will be removed after the October 2026
|
|
2091
|
+
/// release when the mobile dashboard is decommissioned. In the legacy mobile-service flow
|
|
2092
|
+
/// (<code>login(withAPIKey:)</code>) the key can still be used with <code>getResult</code>, <code>tagResult</code>, <code>deleteResult</code>,
|
|
2093
|
+
/// and <code>updateScanName</code> until then. In the Developer Hub flow (<code>startScanSession()</code>) the key is a
|
|
2094
|
+
/// local identifier only and cannot be used with those server methods.
|
|
2095
|
+
- (AxeDevToolsResultKey * _Nullable)postResult:(AxeResult * _Nonnull)result withScanName:(NSString * _Nullable)scanName error:(NSError * _Nullable * _Nullable)error;
|
|
2096
|
+
/// Use this after calling <code>run</code> to send the scan to the server. Will throw an error if sending the scan was not successful.
|
|
2097
|
+
/// \param result The result that should be pushed to the dashboard.
|
|
2098
|
+
///
|
|
2099
|
+
/// \param tags A list of tags that should be associated with the scan, as an array of String.
|
|
2100
|
+
///
|
|
2101
|
+
/// \param scanName A String to change the scan name to in the dashboard.
|
|
2102
|
+
///
|
|
2103
|
+
///
|
|
2104
|
+
/// returns:
|
|
2105
|
+
/// AxeDevToolsResultKey. This type is deprecated and will be removed after the October 2026
|
|
2106
|
+
/// release when the mobile dashboard is decommissioned. In the legacy mobile-service flow
|
|
2107
|
+
/// (<code>login(withAPIKey:)</code>) the key can still be used with <code>getResult</code>, <code>tagResult</code>, <code>deleteResult</code>,
|
|
2108
|
+
/// and <code>updateScanName</code> until then. In the Developer Hub flow (<code>startScanSession()</code>) the key is a
|
|
2109
|
+
/// local identifier only and cannot be used with those server methods.
|
|
2110
|
+
- (AxeDevToolsResultKey * _Nullable)postResult:(AxeResult * _Nonnull)result withTags:(NSArray<NSString *> * _Nonnull)tags withScanName:(NSString * _Nullable)scanName error:(NSError * _Nullable * _Nullable)error SWIFT_DEPRECATED_MSG("The 'withTags' parameter will be removed after the October 2026 release when the mobile dashboard is decommissioned.", "postResult:withScanName:error:");
|
|
2111
|
+
/// Tags the scan in the dashboard with the strings provided. Will throw an error if there was an issue tagging the scan.
|
|
2112
|
+
/// \param resultKey The AxeDevToolsResultKey of the scan you would like to tag.
|
|
2113
|
+
///
|
|
2114
|
+
/// \param tags The tags you would like to give the scan, as <code>[String]</code>.
|
|
2115
|
+
///
|
|
2116
|
+
- (BOOL)tagResult:(AxeDevToolsResultKey * _Nonnull)resultKey withTags:(NSArray<NSString *> * _Nonnull)tags error:(NSError * _Nullable * _Nullable)error SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned.");
|
|
2117
|
+
/// Deletes the scan from the server. The scan will no longer be available on the dashboard. Will throw an error if there was an issue deleting the scan.
|
|
2118
|
+
/// \param resultKey the AxeDevToolsResultKey of the scan that should be deleted from the server.
|
|
2119
|
+
///
|
|
2120
|
+
- (BOOL)deleteResult:(AxeDevToolsResultKey * _Nonnull)resultKey error:(NSError * _Nullable * _Nullable)error SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned.");
|
|
2121
|
+
/// Sets or updates the scan name that is displayed in the dashboard. Will throw an error if there was an issue (re)naming the scan.
|
|
2122
|
+
/// \param resultKey The AxeDevToolsResultKey of the scan you would like to update.
|
|
2123
|
+
///
|
|
2124
|
+
/// \param scanName The name you would like to give the scan.
|
|
2125
|
+
///
|
|
2126
|
+
- (BOOL)updateScanName:(AxeDevToolsResultKey * _Nonnull)resultKey to:(NSString * _Nonnull)scanName error:(NSError * _Nullable * _Nullable)error SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned.");
|
|
2127
|
+
/// Utilize this API with your result from calling <code>run</code> and save your accessibility results locally to your machine as JSON.
|
|
2128
|
+
/// \param result The AxeResult object returned from the <code>run</code> API.
|
|
2129
|
+
///
|
|
2130
|
+
/// \param path Specify the absolute path to save the JSON file
|
|
2131
|
+
///
|
|
2132
|
+
/// \param fileName Specify the filename to be used. Default value will be “<appIdentifier>-<screenTitle>” or if scanName if provided, “<appIdentifier>-<scanName>”.
|
|
2133
|
+
///
|
|
2134
|
+
/// \param scanName Provide a custom scan name, or if none provided, the default will be the screen’s title.
|
|
2135
|
+
///
|
|
2136
|
+
///
|
|
2137
|
+
/// returns:
|
|
2138
|
+
/// The absolute path of the saved file.
|
|
2139
|
+
/// This function will not overwrite a file if the file already exists. Instead, it will attach a number to the end of the file name (for example, “<appIdentifier>-<screenTitle>-1.json”).
|
|
2140
|
+
- (NSString * _Nullable)saveResult:(AxeResult * _Nonnull)result toAbsolutePath:(NSString * _Nonnull)path withFileName:(NSString * _Nonnull)fileName withScanName:(NSString * _Nullable)scanName error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
2141
|
+
/// Utilize this API with your result from calling <code>run</code> and save your accessibility results locally to your machine as JSON.
|
|
2142
|
+
/// \param result The AxeResult object returned from the <code>run</code> API.
|
|
2143
|
+
///
|
|
2144
|
+
/// \param path Specify which folder within your home directory you’d like you JSON saved to. If none is provided, the scan will save into a folder called “AxeDevToolsResults” in your home directory (/Users/yourname/).
|
|
2145
|
+
///
|
|
2146
|
+
/// \param fileName Specify the filename to be used. Default value will be “<appIdentifier>-<screenTitle>” or if scanName if provided, “<appIdentifier>-<scanName>”.
|
|
2147
|
+
///
|
|
2148
|
+
/// \param scanName Provide a custom scan name, or if none provided, the default will be the screen’s title.
|
|
2149
|
+
///
|
|
2150
|
+
///
|
|
2151
|
+
/// returns:
|
|
2152
|
+
/// The absolute path of the saved file.
|
|
2153
|
+
/// This function will not overwrite a file if the file already exists. Instead, it will attach a number to the end of the file name (for example, “<appIdentifier>-<screenTitle>-1.json”).
|
|
2154
|
+
- (NSString * _Nullable)saveResult:(AxeResult * _Nonnull)result toPath:(NSString * _Nonnull)path withFileName:(NSString * _Nonnull)fileName withScanName:(NSString * _Nullable)scanName error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
2155
|
+
/// Use this in a UITest to analyze the accessibility of an application. Useful in testing views built in SwiftUI, Native iOS or React Native.
|
|
2156
|
+
/// \param bundleId The bundle identifier of the application to test. Application must be loaded at the time of the test.
|
|
2157
|
+
///
|
|
2158
|
+
///
|
|
2159
|
+
/// returns:
|
|
2160
|
+
/// the scan, as an AxeResult.
|
|
2161
|
+
- (AxeResult * _Nullable)runOnBundleIdentifier:(NSString * _Nonnull)bundleId error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
2162
|
+
/// Use this in a UITest to analyze the accessibility of a screen or a view. Useful in testing views built in SwiftUI, Native iOS or React Native.
|
|
2163
|
+
/// \param element The root element of the screen you wanted tested, or one component. Must be an XCUIElement.
|
|
2164
|
+
///
|
|
2165
|
+
///
|
|
2166
|
+
/// returns:
|
|
2167
|
+
/// the scan, as an AxeResult.
|
|
2168
|
+
- (AxeResult * _Nullable)runOnElement:(id _Nonnull)element error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
2169
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2170
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2171
|
+
@end
|
|
2172
|
+
|
|
2173
|
+
@class AxeReportResult;
|
|
2174
|
+
@interface AxeDevTools (SWIFT_EXTENSION(axeDevToolsXCUI))
|
|
2175
|
+
/// Generates an HTML report and logs an accessibility summary from all scan results
|
|
2176
|
+
/// accumulated since the last call to this method (or since the instance was created).
|
|
2177
|
+
/// Call this after one or more <code>run</code> calls to produce a self-contained HTML report
|
|
2178
|
+
/// and a printed summary of every accessibility issue found across all scans.
|
|
2179
|
+
/// Each call <em>flushes</em> the accumulated results, so subsequent calls only include
|
|
2180
|
+
/// scans performed after the previous call. This makes it safe to call multiple
|
|
2181
|
+
/// times within a single test run to produce separate reports per flow.
|
|
2182
|
+
/// \param outputPath The directory where the report and summary files should
|
|
2183
|
+
/// be saved. Accepts an absolute path or a <code>~</code>-prefixed path relative to the home
|
|
2184
|
+
/// directory. Defaults to <code>~/AxeDevToolsMobileResults</code> when omitted or <code>nil</code>.
|
|
2185
|
+
///
|
|
2186
|
+
///
|
|
2187
|
+
/// throws:
|
|
2188
|
+
/// An error if the HTML report cannot be written to disk.
|
|
2189
|
+
///
|
|
2190
|
+
/// returns:
|
|
2191
|
+
/// An <code>AxeReportResult</code> containing the path to the generated HTML file
|
|
2192
|
+
/// and the full summary text that was logged to the console.
|
|
2193
|
+
- (AxeReportResult * _Nullable)generateHtmlReportAndSummaryWithOutputPath:(NSString * _Nullable)outputPath error:(NSError * _Nullable * _Nullable)error;
|
|
2194
|
+
@end
|
|
2195
|
+
|
|
2196
|
+
@interface AxeDevTools (SWIFT_EXTENSION(axeDevToolsXCUI))
|
|
2197
|
+
/// This function logs you into the cloud instance of axeDevTools. You must have a valid session before utilizing the framework’s features.
|
|
2198
|
+
/// <ul>
|
|
2199
|
+
/// <li>
|
|
2200
|
+
/// For Objective-C, pass in an empty String to the <code>url</code> parameter and the default server will be used.
|
|
2201
|
+
/// </li>
|
|
2202
|
+
/// <li>
|
|
2203
|
+
/// Will throw an error if the API key is not valid.
|
|
2204
|
+
/// </li>
|
|
2205
|
+
/// <li>
|
|
2206
|
+
/// Google authentication information does not work in this method.
|
|
2207
|
+
/// </li>
|
|
2208
|
+
/// </ul>
|
|
2209
|
+
/// \param apiKey API Key for axeDevTools.
|
|
2210
|
+
///
|
|
2211
|
+
/// \param url URL of the server receiving the scans if it’s not Deque’s service. This should only be filled out for enterprises with their own instance.
|
|
2212
|
+
///
|
|
2213
|
+
///
|
|
2214
|
+
/// returns:
|
|
2215
|
+
/// An instantiated AxeDevTools object. You will not be able to scan anything without this object.
|
|
2216
|
+
+ (AxeDevTools * _Nullable)loginWithAPIKey:(NSString * _Nonnull)apiKey toServer:(NSString * _Nonnull)url error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned. Use AxeDevTools.startScanSession(apiKey:axeAccountUrl:projectId:axeUploadResults:) instead; it targets the Axe Developer Hub");
|
|
2217
|
+
/// Starts a session with the axeDevTools cloud instance using an API key and optional project ID.
|
|
2218
|
+
/// Use this method to initialize axeDevTools for accessibility testing. A valid session is required before utilizing the framework’s features.
|
|
2219
|
+
/// <ul>
|
|
2220
|
+
/// <li>
|
|
2221
|
+
/// If no <code>projectId</code> is provided, results can only be saved locally or posted to the Axe DevTools Mobile Dashboard. Provide a <code>projectId</code> to upload results to Axe Developer Hub.
|
|
2222
|
+
/// </li>
|
|
2223
|
+
/// <li>
|
|
2224
|
+
/// For Objective-C, pass in an empty String to the <code>url</code> parameter and the default server will be used.
|
|
2225
|
+
/// </li>
|
|
2226
|
+
/// <li>
|
|
2227
|
+
/// Will throw an error if the API key is not valid.
|
|
2228
|
+
/// </li>
|
|
2229
|
+
/// </ul>
|
|
2230
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
2231
|
+
///
|
|
2232
|
+
/// \param url URL of the server receiving the scans if it’s not Deque’s service. This should only be filled out for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
2233
|
+
///
|
|
2234
|
+
/// \param projectId The project ID for uploading results to Axe Developer Hub. Defaults to empty string (no project).
|
|
2235
|
+
///
|
|
2236
|
+
///
|
|
2237
|
+
/// throws:
|
|
2238
|
+
/// An error if the API key is invalid or authentication fails.
|
|
2239
|
+
///
|
|
2240
|
+
/// returns:
|
|
2241
|
+
/// An instantiated AxeDevTools object ready for accessibility testing.
|
|
2242
|
+
+ (AxeDevTools * _Nullable)startSessionWithApiKey:(NSString * _Nonnull)apiKey url:(NSString * _Nonnull)url projectId:(NSString * _Nonnull)projectId error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned. Use AxeDevTools.startScanSession(apiKey:axeAccountUrl:projectId:axeUploadResults:) instead; it targets the Axe Developer Hub");
|
|
2243
|
+
/// Starts a session asynchronously with the axeDevTools cloud instance using an API key and project ID.
|
|
2244
|
+
/// This is the asynchronous version of <code>startSession(apiKey:url:projectId:)</code> that uses a completion handler to return results. A valid session is required before utilizing the framework’s features.
|
|
2245
|
+
/// <ul>
|
|
2246
|
+
/// <li>
|
|
2247
|
+
/// For Objective-C, pass in an empty String to the <code>url</code> parameter and the default server will be used.
|
|
2248
|
+
/// </li>
|
|
2249
|
+
/// <li>
|
|
2250
|
+
/// The completion handler is called with an error if the API key is not valid, or with <code>AxeClient.Errors.projectIdRequiredForUpload</code> if <code>axeUploadResults</code> is true and no <code>projectId</code> was supplied.
|
|
2251
|
+
/// </li>
|
|
2252
|
+
/// </ul>
|
|
2253
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
2254
|
+
///
|
|
2255
|
+
/// \param url URL of the server receiving the scans if it’s not Deque’s service. This should only be filled out for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
2256
|
+
///
|
|
2257
|
+
/// \param projectId The project ID for uploading results to Axe Developer Hub.
|
|
2258
|
+
///
|
|
2259
|
+
/// \param completion A closure called when the session initialization completes. On success, provides an initialized <code>AxeDevTools</code> instance and a <code>nil</code> error. On failure, provides a <code>nil</code> instance and the error that occurred.
|
|
2260
|
+
///
|
|
2261
|
+
+ (void)startSessionWithApiKey:(NSString * _Nonnull)apiKey toServer:(NSString * _Nonnull)url usingProjectId:(NSString * _Nonnull)projectId :(void (^ _Nonnull)(AxeDevTools * _Nullable, NSError * _Nullable))completion SWIFT_DEPRECATED_MSG("This method will be removed after the October 2026 release when the mobile dashboard is decommissioned. Use AxeDevTools.startScanSession(withApiKey:withAxeAccountUrl:usingProjectId:axeUploadResults:_:) instead; it targets the Axe Developer Hub");
|
|
2262
|
+
/// Starts a session with the axeDevTools cloud instance using an API key and project ID.
|
|
2263
|
+
/// This is the recommended method to initialize axeDevTools for accessibility testing. A valid session is required before utilizing the framework’s features.
|
|
2264
|
+
/// <ul>
|
|
2265
|
+
/// <li>
|
|
2266
|
+
/// For Objective-C, pass in an empty String to the <code>axeAccountUrl</code> parameter and the default server will be used.
|
|
2267
|
+
/// </li>
|
|
2268
|
+
/// <li>
|
|
2269
|
+
/// Will throw an error if the API key or projectId is not valid, or if <code>axeUploadResults</code> is true and no <code>projectId</code> was supplied.
|
|
2270
|
+
/// </li>
|
|
2271
|
+
/// </ul>
|
|
2272
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
2273
|
+
///
|
|
2274
|
+
/// \param axeAccountUrl URL of the server receiving the scans if it’s not Deque’s service. This should only be filled out for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
2275
|
+
///
|
|
2276
|
+
/// \param projectId The project ID for uploading results to Axe Developer Hub. Required when <code>axeUploadResults</code> is true; may be omitted only when <code>axeUploadResults</code> is false.
|
|
2277
|
+
///
|
|
2278
|
+
/// \param axeUploadResults Whether results from this session should be uploaded to Axe Developer Hub. Defaults to true.
|
|
2279
|
+
///
|
|
2280
|
+
///
|
|
2281
|
+
/// throws:
|
|
2282
|
+
/// An error if either <code>axeUploadResults</code> is true and <code>projectId</code> is absent or empty or if the API key or projectId is invalid or authentication fails.
|
|
2283
|
+
///
|
|
2284
|
+
/// returns:
|
|
2285
|
+
/// An instantiated AxeDevTools object ready for accessibility testing.
|
|
2286
|
+
+ (AxeDevTools * _Nullable)startScanSessionWithApiKey:(NSString * _Nonnull)apiKey axeAccountUrl:(NSString * _Nonnull)axeAccountUrl projectId:(NSString * _Nullable)projectId axeUploadResults:(BOOL)axeUploadResults error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
2287
|
+
/// Starts a session asynchronously with the axeDevTools cloud instance using an API key and project ID.
|
|
2288
|
+
/// This is the asynchronous version of <code>startScanSession(apiKey:axeAccountUrl:projectId:axeUploadResults:)</code> that uses a completion handler to return results. A valid session is required before utilizing the framework’s features.
|
|
2289
|
+
/// <ul>
|
|
2290
|
+
/// <li>
|
|
2291
|
+
/// For Objective-C, pass in an empty String to the <code>axeAccountUrl</code> parameter and the default server will be used.
|
|
2292
|
+
/// </li>
|
|
2293
|
+
/// <li>
|
|
2294
|
+
/// The completion handler is called with an error if the API key is not valid.
|
|
2295
|
+
/// </li>
|
|
2296
|
+
/// </ul>
|
|
2297
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
2298
|
+
///
|
|
2299
|
+
/// \param axeAccountUrl URL of the server receiving the scans if it’s not Deque’s service. This should only be filled out for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
2300
|
+
///
|
|
2301
|
+
/// \param projectId The project ID for uploading results to Axe Developer Hub. Required when <code>axeUploadResults</code> is true; may be omitted only when <code>axeUploadResults</code> is false.
|
|
2302
|
+
///
|
|
2303
|
+
/// \param axeUploadResults Whether results from this session should be uploaded to Axe Developer Hub. Defaults to true.
|
|
2304
|
+
///
|
|
2305
|
+
/// \param completion A closure called when the session initialization completes. On success, provides an initialized <code>AxeDevTools</code> instance and a <code>nil</code> error. On failure, provides a <code>nil</code> instance and the error that occurred.
|
|
2306
|
+
///
|
|
2307
|
+
+ (void)startScanSessionWithApiKey:(NSString * _Nonnull)apiKey withAxeAccountUrl:(NSString * _Nonnull)axeAccountUrl usingProjectId:(NSString * _Nullable)projectId axeUploadResults:(BOOL)axeUploadResults :(void (^ _Nonnull)(AxeDevTools * _Nullable, NSError * _Nullable))completion;
|
|
2308
|
+
/// Starts a session with the axeDevTools cloud instance using an API key and project ID.
|
|
2309
|
+
/// Results from this session are always uploaded to Axe Developer Hub. To authenticate and scan
|
|
2310
|
+
/// without uploading, use <code>startScanSessionWithApiKey:axeAccountUrl:projectId:axeUploadResults:error:</code>
|
|
2311
|
+
/// with <code>axeUploadResults</code> set to <code>NO</code>.
|
|
2312
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
2313
|
+
///
|
|
2314
|
+
/// \param axeAccountUrl URL of the server receiving the scans. Pass an empty string for Deque’s.
|
|
2315
|
+
///
|
|
2316
|
+
/// \param projectId The project ID for uploading results to Axe Developer Hub.
|
|
2317
|
+
///
|
|
2318
|
+
///
|
|
2319
|
+
/// throws:
|
|
2320
|
+
/// An error if the API key or projectId is invalid, or authentication fails.
|
|
2321
|
+
///
|
|
2322
|
+
/// returns:
|
|
2323
|
+
/// An instantiated AxeDevTools object ready for accessibility testing.
|
|
2324
|
+
+ (AxeDevTools * _Nullable)startScanSessionWithApiKey:(NSString * _Nonnull)apiKey axeAccountUrl:(NSString * _Nonnull)axeAccountUrl projectId:(NSString * _Nonnull)projectId error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
2325
|
+
/// Starts a session asynchronously. Results are always uploaded to Axe Developer Hub; use the
|
|
2326
|
+
/// <code>axeUploadResults:</code> variant with <code>NO</code> to authenticate and scan without uploading.
|
|
2327
|
+
+ (void)startScanSessionWithApiKey:(NSString * _Nonnull)apiKey withAxeAccountUrl:(NSString * _Nonnull)axeAccountUrl usingProjectId:(NSString * _Nonnull)projectId :(void (^ _Nonnull)(AxeDevTools * _Nullable, NSError * _Nullable))completion;
|
|
2328
|
+
/// Authenticates with a pre-obtained OAuth access token.
|
|
2329
|
+
/// Use this when your integration already holds a valid Bearer token
|
|
2330
|
+
/// (e.g., from an MCP server) and you want to run local scans without
|
|
2331
|
+
/// uploading results to the Deque backend.
|
|
2332
|
+
/// \param accessToken A valid OAuth access token (Bearer token).
|
|
2333
|
+
///
|
|
2334
|
+
/// \param axeAccountUrl URL of the axe account instance. Only needed for
|
|
2335
|
+
/// enterprises with their own instance. Defaults to empty string (uses default server).
|
|
2336
|
+
///
|
|
2337
|
+
///
|
|
2338
|
+
/// throws:
|
|
2339
|
+
/// An error if the access token is invalid or authentication fails.
|
|
2340
|
+
///
|
|
2341
|
+
/// returns:
|
|
2342
|
+
/// An initialized AxeDevTools object ready for local scanning.
|
|
2343
|
+
+ (AxeDevTools * _Nullable)loginWithAccessToken:(NSString * _Nonnull)accessToken axeAccountUrl:(NSString * _Nonnull)axeAccountUrl error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
2344
|
+
/// Authenticates with the Axe Developer Hub using an API key without creating a scan session.
|
|
2345
|
+
/// Use this when you only need to validate credentials and run scans locally (no result upload).
|
|
2346
|
+
/// <ul>
|
|
2347
|
+
/// <li>
|
|
2348
|
+
/// For Objective-C, pass in an empty String to the <code>axeAccountUrl</code> parameter and the default server will be used.
|
|
2349
|
+
/// </li>
|
|
2350
|
+
/// </ul>
|
|
2351
|
+
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
2352
|
+
///
|
|
2353
|
+
/// \param axeAccountUrl URL of the axe account instance. Only needed for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
2354
|
+
///
|
|
2355
|
+
///
|
|
2356
|
+
/// throws:
|
|
2357
|
+
/// An error if the API key is invalid or authentication fails.
|
|
2358
|
+
///
|
|
2359
|
+
/// returns:
|
|
2360
|
+
/// An initialized AxeDevTools object ready for local scanning.
|
|
2361
|
+
+ (AxeDevTools * _Nullable)authenticateWithApiKey:(NSString * _Nonnull)apiKey axeAccountUrl:(NSString * _Nonnull)axeAccountUrl error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
2362
|
+
@end
|
|
2363
|
+
|
|
2364
|
+
/// A scan’s unique identifier on the axeDevTools Mobile server. You can use the AxeDevToolsResultKey to retrieve, tag, and
|
|
2365
|
+
/// delete scans on the server.
|
|
2366
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI20AxeDevToolsResultKey") SWIFT_DEPRECATED_MSG("This will be removed after the October 2026 release when the mobile dashboard is decommissioned.")
|
|
2367
|
+
@interface AxeDevToolsResultKey : NSObject
|
|
2368
|
+
/// The name of the application that the scan came from. Should be the Bundle Identifier.
|
|
2369
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull packageName;
|
|
2370
|
+
/// A unique String associated with the user who pushed up the scan. This is not the same as the username.
|
|
2371
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull userId;
|
|
2372
|
+
/// A unique String associated with the specific scan.
|
|
2373
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull resultId;
|
|
2374
|
+
/// A unique String provided by the backend. If uuid was not provided by
|
|
2375
|
+
/// the backend, the uuid will be the same as <code>resultId</code>. They may also
|
|
2376
|
+
/// be the same in general.
|
|
2377
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull uuid;
|
|
2378
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
2379
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
2380
|
+
/// Use this in UI Testing to convert the Floating Action Button title into a valid AxeDevToolsResultKey. This can then be used to retrieve the scan from the server, tag it, change its name, and delete it.
|
|
2381
|
+
/// This initializer will return <code>nil</code> if the given String is not in the expected format. If supplying the FAB’s title directly and this method is returning <code>nil</code>, it may mean that there was an error sending the scan to the server.
|
|
2382
|
+
/// \param fabTitle The FloatingActionButton’s <code>title</code> or <code>label</code> property after it is tapped.
|
|
2383
|
+
///
|
|
2384
|
+
- (nullable instancetype)initWithFabTitle:(NSString * _Nonnull)fabTitle OBJC_DESIGNATED_INITIALIZER;
|
|
2385
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2386
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2387
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2388
|
+
@end
|
|
2389
|
+
|
|
2390
|
+
/// Information about the device used when the scan was created.
|
|
2391
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeDevice")
|
|
2392
|
+
@interface AxeDevice : NSObject
|
|
2393
|
+
/// The name of the device
|
|
2394
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull name;
|
|
2395
|
+
/// The operating system that the device was running. Will likely be “iOS”.
|
|
2396
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull os;
|
|
2397
|
+
/// The iOS version that the device was running at the time of the scan.
|
|
2398
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull osVersion;
|
|
2399
|
+
/// The device’s screen height, in pixels
|
|
2400
|
+
@property (nonatomic, readonly) float screenHeight;
|
|
2401
|
+
/// The device’s screen width, in pixels
|
|
2402
|
+
@property (nonatomic, readonly) float screenWidth;
|
|
2403
|
+
/// The number of pixels in one iOS point (pt)
|
|
2404
|
+
@property (nonatomic, readonly) float scale;
|
|
2405
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
2406
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2407
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2408
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2409
|
+
@end
|
|
2410
|
+
|
|
2411
|
+
/// The type of object. Derived from <code>XCUIElement.ElementType</code>.
|
|
2412
|
+
/// <h2>Why this enum covers macOS types too</h2>
|
|
2413
|
+
/// Apple ships a <em>single</em> <code>XCUIElement.ElementType</code> enum across all platforms — the iPhoneOS XCTest header contains every case (rawValues 0…82) including the macOS-only ones (<code>drawer</code>, <code>dockItem</code>, <code>helpTag</code>, <code>touchBar</code>, etc.). There is no separate iOS-only or iPadOS-only enum: Apple reuses the same numeric value for the same conceptual element across platforms, and just doesn’t emit the macOS-specific cases when scanning iOS apps. Verified against Xcode 16’s iPhoneOS XCTest header at <code>XCTest.framework/Headers/XCUIElementTypes.h</code>.
|
|
2414
|
+
/// We therefore mirror the <em>full</em> set of 0…82 here. This guarantees <code>AxeElementType(rawValue:)</code> succeeds for any rawValue Apple currently has in production, which prevents <code>"RawValue N not supported."</code> debug logs and keeps <code>AxeElement.elementType</code> from silently degrading to <code>.any</code> views for which Apple has a real type.
|
|
2415
|
+
/// Cases without a trailing comment are available on iOS (and typically iPadOS / macOS too). A case is only annotated when it does <em>not</em> appear on iOS — either iPadOS-only or macOS-only. Our rules’ applicability checks don’t reference macOS-only types, so cases marked <code>macOS</code> will never end up in results from an iOS scan.
|
|
2416
|
+
/// Note: the <code>// iPadOS</code>, <code>// macOS</code> annotations describe Apple’s emission behavior at time of writing — they are documentation, not compile-time guarantees. If Apple changes which types are emitted on which platforms in a future SDK, the annotations may drift; re-check against <code>XCUIElementTypes.h</code> when adopting a new Xcode.
|
|
2417
|
+
/// If Apple ever extends the enum past 82, the fallback path in <code>AxeElementType-Ext.swift</code> will
|
|
2418
|
+
/// throw <code>ElementTypeInitError</code> and log it at debug level — same behavior we’ve always had for
|
|
2419
|
+
/// unknown rawValues.
|
|
2420
|
+
typedef SWIFT_ENUM(NSUInteger, AxeElementType, open) {
|
|
2421
|
+
AxeElementTypeAny = 0,
|
|
2422
|
+
/// Any view not otherwise described by the other options available in this enum.
|
|
2423
|
+
AxeElementTypeOther = 1,
|
|
2424
|
+
AxeElementTypeApplication = 2,
|
|
2425
|
+
AxeElementTypeGroup = 3,
|
|
2426
|
+
AxeElementTypeWindow = 4,
|
|
2427
|
+
AxeElementTypeSheet = 5,
|
|
2428
|
+
AxeElementTypeDrawer = 6,
|
|
2429
|
+
AxeElementTypeAlert = 7,
|
|
2430
|
+
AxeElementTypeDialog = 8,
|
|
2431
|
+
AxeElementTypeButton = 9,
|
|
2432
|
+
AxeElementTypeRadioButton = 10,
|
|
2433
|
+
AxeElementTypeRadioGroup = 11,
|
|
2434
|
+
AxeElementTypeCheckBox = 12,
|
|
2435
|
+
AxeElementTypeDisclosureTriangle = 13,
|
|
2436
|
+
AxeElementTypePopUpButton = 14,
|
|
2437
|
+
AxeElementTypeComboBox = 15,
|
|
2438
|
+
AxeElementTypeMenuButton = 16,
|
|
2439
|
+
AxeElementTypeToolbarButton = 17,
|
|
2440
|
+
AxeElementTypePopover = 18,
|
|
2441
|
+
AxeElementTypeKeyboard = 19,
|
|
2442
|
+
AxeElementTypeKey = 20,
|
|
2443
|
+
AxeElementTypeNavigationBar = 21,
|
|
2444
|
+
AxeElementTypeTabBar = 22,
|
|
2445
|
+
AxeElementTypeTabGroup = 23,
|
|
2446
|
+
AxeElementTypeToolbar = 24,
|
|
2447
|
+
AxeElementTypeStatusBar = 25,
|
|
2448
|
+
AxeElementTypeTable = 26,
|
|
2449
|
+
AxeElementTypeTableRow = 27,
|
|
2450
|
+
AxeElementTypeTableColumn = 28,
|
|
2451
|
+
AxeElementTypeOutline = 29,
|
|
2452
|
+
AxeElementTypeOutlineRow = 30,
|
|
2453
|
+
AxeElementTypeBrowser = 31,
|
|
2454
|
+
AxeElementTypeCollectionView = 32,
|
|
2455
|
+
AxeElementTypeSlider = 33,
|
|
2456
|
+
AxeElementTypePageIndicator = 34,
|
|
2457
|
+
AxeElementTypeProgressIndicator = 35,
|
|
2458
|
+
AxeElementTypeActivityIndicator = 36,
|
|
2459
|
+
AxeElementTypeSegmentedControl = 37,
|
|
2460
|
+
AxeElementTypePicker = 38,
|
|
2461
|
+
AxeElementTypePickerWheel = 39,
|
|
2462
|
+
AxeElementTypeSwitch = 40,
|
|
2463
|
+
AxeElementTypeToggle = 41,
|
|
2464
|
+
AxeElementTypeLink = 42,
|
|
2465
|
+
AxeElementTypeImage = 43,
|
|
2466
|
+
AxeElementTypeIcon = 44,
|
|
2467
|
+
AxeElementTypeSearchField = 45,
|
|
2468
|
+
AxeElementTypeScrollView = 46,
|
|
2469
|
+
AxeElementTypeScrollBar = 47,
|
|
2470
|
+
AxeElementTypeStaticText = 48,
|
|
2471
|
+
AxeElementTypeTextField = 49,
|
|
2472
|
+
AxeElementTypeSecureTextField = 50,
|
|
2473
|
+
AxeElementTypeDatePicker = 51,
|
|
2474
|
+
AxeElementTypeTextView = 52,
|
|
2475
|
+
AxeElementTypeMenu = 53,
|
|
2476
|
+
AxeElementTypeMenuItem = 54,
|
|
2477
|
+
AxeElementTypeMenuBar = 55,
|
|
2478
|
+
AxeElementTypeMenuBarItem = 56,
|
|
2479
|
+
AxeElementTypeMap = 57,
|
|
2480
|
+
AxeElementTypeWebView = 58,
|
|
2481
|
+
AxeElementTypeIncrementArrow = 59,
|
|
2482
|
+
AxeElementTypeDecrementArrow = 60,
|
|
2483
|
+
AxeElementTypeTimeline = 61,
|
|
2484
|
+
AxeElementTypeRatingIndicator = 62,
|
|
2485
|
+
AxeElementTypeValueIndicator = 63,
|
|
2486
|
+
AxeElementTypeSplitGroup = 64,
|
|
2487
|
+
AxeElementTypeSplitter = 65,
|
|
2488
|
+
AxeElementTypeRelevanceIndicator = 66,
|
|
2489
|
+
AxeElementTypeColorWell = 67,
|
|
2490
|
+
AxeElementTypeHelpTag = 68,
|
|
2491
|
+
AxeElementTypeMatte = 69,
|
|
2492
|
+
AxeElementTypeDockItem = 70,
|
|
2493
|
+
AxeElementTypeRuler = 71,
|
|
2494
|
+
AxeElementTypeRulerMarker = 72,
|
|
2495
|
+
AxeElementTypeGrid = 73,
|
|
2496
|
+
AxeElementTypeLevelIndicator = 74,
|
|
2497
|
+
AxeElementTypeCell = 75,
|
|
2498
|
+
AxeElementTypeLayoutArea = 76,
|
|
2499
|
+
AxeElementTypeLayoutItem = 77,
|
|
2500
|
+
AxeElementTypeHandle = 78,
|
|
2501
|
+
AxeElementTypeStepper = 79,
|
|
2502
|
+
AxeElementTypeTab = 80,
|
|
2503
|
+
AxeElementTypeTouchBar = 81,
|
|
2504
|
+
AxeElementTypeStatusItem = 82,
|
|
2505
|
+
};
|
|
2506
|
+
|
|
2507
|
+
/// A screenshot of a view, or the entire device’s screen.
|
|
2508
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI8AxeImage")
|
|
2509
|
+
@interface AxeImage : NSObject
|
|
2510
|
+
/// The screenshot, converted to base64
|
|
2511
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull base64png;
|
|
2512
|
+
/// The size of the image, in pixels
|
|
2513
|
+
@property (nonatomic, readonly, strong) AxeBounds * _Nonnull frame;
|
|
2514
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
2515
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2516
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2517
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2518
|
+
@end
|
|
2519
|
+
|
|
2520
|
+
/// How serious a failure of a rule is.
|
|
2521
|
+
typedef SWIFT_ENUM(NSInteger, AxeImpact, open) {
|
|
2522
|
+
/// the application is usable but has some annoyances. This is the least severe impact.
|
|
2523
|
+
AxeImpactMINOR = 0,
|
|
2524
|
+
/// the application is usable but may be slightly more difficult to use for some users.
|
|
2525
|
+
AxeImpactMODERATE = 1,
|
|
2526
|
+
/// the application is difficult to use for some users.
|
|
2527
|
+
AxeImpactSERIOUS = 2,
|
|
2528
|
+
/// the application may not be usable or may be very difficult to use for some users.
|
|
2529
|
+
AxeImpactCRITICAL = 3,
|
|
2530
|
+
};
|
|
2531
|
+
|
|
2532
|
+
SWIFT_ENUM_FWD_DECL(NSInteger, AxeProductKind)
|
|
2533
|
+
SWIFT_ENUM_FWD_DECL(NSInteger, AxeUsageActor)
|
|
2534
|
+
/// Lets a downstream integration (WebDriverAgent, the Desktop Mobile Analyzer) declare
|
|
2535
|
+
/// which product is driving the current process, so Amplitude can distinguish an
|
|
2536
|
+
/// Appium-driven scan (and its major version) from a customer calling the SDK directly.
|
|
2537
|
+
/// Describes the <em>process</em>, not a scan session: set at most once, never cleared.
|
|
2538
|
+
/// <code>AutoScanManager.tearDown()</code> must not reset it.
|
|
2539
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI14AxeIntegration")
|
|
2540
|
+
@interface AxeIntegration : NSObject
|
|
2541
|
+
/// Called once per process by the integrating product to identify itself. A second
|
|
2542
|
+
/// call declaring a different product is logged and ignored, not silently applied.
|
|
2543
|
+
+ (void)declareProduct:(enum AxeProductKind)product version:(NSString * _Nonnull)version;
|
|
2544
|
+
/// Called once per process by the integrating layer (the Appium driver, the Desktop
|
|
2545
|
+
/// Analyzer, MCP) to say who triggered this session and which product surface it came
|
|
2546
|
+
/// from. Public so those layers can call it; deliberately absent from customer docs and
|
|
2547
|
+
/// not part of the supported surface.
|
|
2548
|
+
/// <em>Call this before session init.</em> A session captures these values when it starts
|
|
2549
|
+
/// (<code>AxeClient.usageAttribution</code>), and its usage-service events and session-init analytics
|
|
2550
|
+
/// event are all stamped from that one capture.
|
|
2551
|
+
/// A call that lands afterwards therefore applies to the <em>next</em> session started in this
|
|
2552
|
+
/// process, never to one already running. There is no warning for a late call, because
|
|
2553
|
+
/// the process cannot tell a mistimed call apart from correct setup for the next session.
|
|
2554
|
+
/// Unlike <code>declareProduct</code>, which ignores a conflicting second call, this is last write
|
|
2555
|
+
/// wins. The SDK appends the platform suffix, so pass <code>appium</code>, not <code>appium-ios</code>. A
|
|
2556
|
+
/// <code>productComponent</code> that sanitizes to nothing leaves the previous value in place
|
|
2557
|
+
/// rather than clearing it; the <code>actor</code> from the same call still applies.
|
|
2558
|
+
/// \param actor Whether a person or an automated run triggered the session.
|
|
2559
|
+
///
|
|
2560
|
+
/// \param productComponent The upstream product surface, unsuffixed, e.g. <code>mcp</code> or <code>appium</code>.
|
|
2561
|
+
///
|
|
2562
|
+
+ (void)setUsageWithActor:(enum AxeUsageActor)actor productComponent:(NSString * _Nonnull)productComponent;
|
|
2563
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2564
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2565
|
+
@end
|
|
2566
|
+
|
|
2567
|
+
/// The meta data of a scan.
|
|
2568
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI11AxeMetaData")
|
|
2569
|
+
@interface AxeMetaData : NSObject
|
|
2570
|
+
/// The application that was scanned
|
|
2571
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull appIdentifier;
|
|
2572
|
+
/// The time that the scan occurred
|
|
2573
|
+
@property (nonatomic, readonly) int64_t analysisTimestamp;
|
|
2574
|
+
/// The version of axeDevTools iOS used
|
|
2575
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull axeVersion;
|
|
2576
|
+
/// The title of the screen that was scanned, if available
|
|
2577
|
+
@property (nonatomic, copy) NSString * _Nonnull screenTitle;
|
|
2578
|
+
@property (nonatomic, readonly) BOOL isFullScreenForML;
|
|
2579
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
2580
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
2581
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2582
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2583
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2584
|
+
@end
|
|
2585
|
+
|
|
2586
|
+
typedef SWIFT_ENUM(NSUInteger, AxeOrientation, open) {
|
|
2587
|
+
AxeOrientationAll = 0,
|
|
2588
|
+
AxeOrientationPortrait = 1,
|
|
2589
|
+
AxeOrientationLandscape = 2,
|
|
2590
|
+
};
|
|
2591
|
+
|
|
2592
|
+
/// A location on the screen, either in pixels or iOS points (pt). Usually converted from a CGPoint
|
|
2593
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI8AxePoint")
|
|
2594
|
+
@interface AxePoint : NSObject
|
|
2595
|
+
/// The horizontal location of the point.
|
|
2596
|
+
@property (nonatomic, readonly) NSInteger x;
|
|
2597
|
+
/// The vertical location of the point.
|
|
2598
|
+
@property (nonatomic, readonly) NSInteger y;
|
|
2599
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
2600
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2601
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2602
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2603
|
+
@end
|
|
2604
|
+
|
|
2605
|
+
/// Downstream products that can explicitly identify themselves to the framework.
|
|
2606
|
+
/// <code>@objc</code>-bridged so a typo in an Objective-C caller is a build failure, not a silently
|
|
2607
|
+
/// wrong value. Raw values are a published wire contract: append only, never renumber.
|
|
2608
|
+
typedef SWIFT_ENUM(NSInteger, AxeProductKind, open) {
|
|
2609
|
+
AxeProductKindAppium2 = 0,
|
|
2610
|
+
AxeProductKindAppium3 = 1,
|
|
2611
|
+
AxeProductKindDesktopAnalyzer = 2,
|
|
2612
|
+
};
|
|
2613
|
+
|
|
2614
|
+
/// AxeProps are all properties used to help identify views in an application and to figure out whether a view is accessible
|
|
2615
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI8AxeProps")
|
|
2616
|
+
@interface AxeProps : NSObject
|
|
2617
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
2618
|
+
/// Creates an empty AxeProps object.
|
|
2619
|
+
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
2620
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2621
|
+
@end
|
|
2622
|
+
|
|
2623
|
+
/// The result returned by <code>generateHtmlReportAndSummary()</code>, containing the
|
|
2624
|
+
/// path to the generated HTML report file and the full summary string that
|
|
2625
|
+
/// was logged to the console.
|
|
2626
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI15AxeReportResult")
|
|
2627
|
+
@interface AxeReportResult : NSObject
|
|
2628
|
+
/// The full path to the generated HTML report file.
|
|
2629
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull htmlReportPath;
|
|
2630
|
+
/// The aggregated summary text that was logged to the Xcode console.
|
|
2631
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull summary;
|
|
2632
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2633
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2634
|
+
@end
|
|
2635
|
+
|
|
2636
|
+
@class AxeRuleResult;
|
|
2637
|
+
/// This class contains all the information from one accessibility scan of a screen. This is a Swift representation of the JSON sent to the axe DevTools Mobile server (if using UI automated tests or manual tests). This can be used to assert number of accessibility failures and passes on one screen. It also contains the view hierarchy of what was scanned and which rules were run.
|
|
2638
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeResult")
|
|
2639
|
+
@interface AxeResult : NSObject
|
|
2640
|
+
@property (nonatomic, copy) NSString * _Nullable sessionId;
|
|
2641
|
+
@property (nonatomic, copy) NSString * _Nullable scanName;
|
|
2642
|
+
@property (nonatomic, copy) NSArray<NSString *> * _Nullable tags SWIFT_DEPRECATED_MSG("This will be removed after the October 2026 release when the mobile dashboard is decommissioned.");
|
|
2643
|
+
/// The configuration of the scan
|
|
2644
|
+
@property (nonatomic, readonly, strong) AxeConf * _Nonnull axeConf;
|
|
2645
|
+
/// Information about the screen that was scanned
|
|
2646
|
+
@property (nonatomic, readonly, strong) AxeContext * _Nonnull axeContext;
|
|
2647
|
+
/// A list of failing, passing, ignored, and incomplete results
|
|
2648
|
+
@property (nonatomic, readonly, copy) NSArray<AxeRuleResult *> * _Nonnull axeRuleResults;
|
|
2649
|
+
/// All failures in the scan
|
|
2650
|
+
@property (nonatomic, readonly, copy) NSArray<AxeRuleResult *> * _Nonnull failures;
|
|
2651
|
+
/// All passes in the scan
|
|
2652
|
+
@property (nonatomic, readonly, copy) NSArray<AxeRuleResult *> * _Nonnull passes;
|
|
2653
|
+
/// All incompletes in the scan
|
|
2654
|
+
@property (nonatomic, readonly, copy) NSArray<AxeRuleResult *> * _Nonnull incompletes;
|
|
2655
|
+
/// A complete description of the result. Contains summaries for each rule and prints out information about
|
|
2656
|
+
/// any failing views.
|
|
2657
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
2658
|
+
/// Summary of the scan. Contains the number of failures, passes, and incompletes.
|
|
2659
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull shortDescription;
|
|
2660
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2661
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2662
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2663
|
+
@end
|
|
2664
|
+
|
|
2665
|
+
/// The view’s primary purpose.
|
|
2666
|
+
typedef SWIFT_ENUM(NSInteger, AxeRole, open) {
|
|
2667
|
+
/// The view’s primary purpose is to display text. Views that can be interacted with by a user, even if they also display text, are counted as controls.
|
|
2668
|
+
AxeRoleTextElement = 0,
|
|
2669
|
+
/// The view’s primary purpose is to be interacted with by the user. Views that have text within them that are also actionable (such as buttons, textFields, etc) are counted as controls.
|
|
2670
|
+
AxeRoleControl = 1,
|
|
2671
|
+
/// The view’s primary purpose is to display an image.
|
|
2672
|
+
AxeRoleImage = 2,
|
|
2673
|
+
/// The view’s primary purpose is otherwise not mentioned (layout views, background views, etc).
|
|
2674
|
+
AxeRoleGenericElement = 3,
|
|
2675
|
+
};
|
|
2676
|
+
|
|
2677
|
+
/// A unique name for each of the rules the SDK registers. Most run by default; <code>InaccessibleAction</code>
|
|
2678
|
+
/// is the current exception (disabled by default, see <code>AxeConf</code>).
|
|
2679
|
+
typedef SWIFT_ENUM(NSInteger, AxeRuleId, open) {
|
|
2680
|
+
/// Deprecated. Renamed to <code>a11yElementFocusBox</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2681
|
+
AxeRuleIdA11yElementFocusBox = 0,
|
|
2682
|
+
/// Deprecated. Renamed to <code>activeControlName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2683
|
+
AxeRuleIdActiveControlName = 1,
|
|
2684
|
+
/// Deprecated. Renamed to <code>associatedText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2685
|
+
AxeRuleIdAssociatedText = 2,
|
|
2686
|
+
/// Deprecated. Renamed to <code>clippedText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2687
|
+
AxeRuleIdClippedText = 3,
|
|
2688
|
+
/// Deprecated. Renamed to <code>collidingViews</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2689
|
+
AxeRuleIdCollidingViews = 4,
|
|
2690
|
+
/// Deprecated. Renamed to <code>colorContrast</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2691
|
+
AxeRuleIdColorContrast = 5,
|
|
2692
|
+
/// Deprecated. Renamed to <code>conflictingTraits</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2693
|
+
AxeRuleIdConflictingTraits = 6,
|
|
2694
|
+
/// Deprecated. Renamed to <code>focusableText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2695
|
+
AxeRuleIdFocusableText = 7,
|
|
2696
|
+
/// Deprecated. Renamed to <code>imageViewName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2697
|
+
AxeRuleIdImageViewName = 8,
|
|
2698
|
+
/// Deprecated. Renamed to <code>inScrollView</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2699
|
+
AxeRuleIdInScrollView = 9,
|
|
2700
|
+
/// Deprecated. The InaccessibleAction rule is removed entirely in October 2026 (#2995).
|
|
2701
|
+
AxeRuleIdInaccessibleAction = 10,
|
|
2702
|
+
/// Deprecated. Renamed to <code>labelAtFront</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2703
|
+
AxeRuleIdLabelAtFront = 11,
|
|
2704
|
+
/// Deprecated. Renamed to <code>labelInName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2705
|
+
AxeRuleIdLabelInName = 12,
|
|
2706
|
+
/// Deprecated. Renamed to <code>meaningfulAccessibleName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2707
|
+
AxeRuleIdMeaningfulAccessibleName = 13,
|
|
2708
|
+
/// Deprecated. Renamed to <code>nestedElementsName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2709
|
+
AxeRuleIdNestedElementsName = 14,
|
|
2710
|
+
/// Deprecated. Renamed to <code>screenOrientation</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2711
|
+
AxeRuleIdScreenOrientation = 15,
|
|
2712
|
+
/// Deprecated. Renamed to <code>screenTitle</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2713
|
+
AxeRuleIdScreenTitle = 16,
|
|
2714
|
+
/// Deprecated. Renamed to <code>supportsDynamicType</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2715
|
+
AxeRuleIdSupportsDynamicType = 17,
|
|
2716
|
+
/// Deprecated. Renamed to <code>touchTargetSize</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2717
|
+
AxeRuleIdTouchTargetSize = 18,
|
|
2718
|
+
/// Deprecated. Renamed to <code>touchTargetSpacing</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2719
|
+
AxeRuleIdTouchTargetSpacing = 19,
|
|
2720
|
+
};
|
|
2721
|
+
|
|
2722
|
+
SWIFT_ENUM_FWD_DECL(NSInteger, AxeStatus)
|
|
2723
|
+
/// A summary of one rule being run on one view.
|
|
2724
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI13AxeRuleResult")
|
|
2725
|
+
@interface AxeRuleResult : NSObject
|
|
2726
|
+
/// whether the view passed, failed, or returned incomplete on the rule
|
|
2727
|
+
@property (nonatomic, readonly) enum AxeStatus status;
|
|
2728
|
+
/// refers to the end-user impact behind issues found in your scans.
|
|
2729
|
+
/// Read more about impact in the References section of
|
|
2730
|
+
/// axe DevTools Mobile docs at docs.deque.com.
|
|
2731
|
+
@property (nonatomic, readonly) enum AxeImpact impact;
|
|
2732
|
+
/// the name of the rule that was run on the view
|
|
2733
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull ruleId;
|
|
2734
|
+
/// a brief description of the rule that was run on the view
|
|
2735
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull ruleSummary;
|
|
2736
|
+
/// the properties used to determine whether the view passes or fails a rule
|
|
2737
|
+
@property (nonatomic, readonly, strong) AxeProps * _Nonnull props;
|
|
2738
|
+
/// the view’s identifier, calculated from its hash
|
|
2739
|
+
/// This is identical to the AxeViewId present in AxeView
|
|
2740
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull axeViewId;
|
|
2741
|
+
/// whether the view is in the current screenshot. Will be false if the view is off-screen or behind a modal.
|
|
2742
|
+
@property (nonatomic, readonly) BOOL isVisibleToUser;
|
|
2743
|
+
/// Whether a rule is currently experimental or not.
|
|
2744
|
+
/// Deprecated. This flag does not determine whether a rule runs by default — that is decided by
|
|
2745
|
+
/// each rule’s own <code>ignored</code> default (see <code>AxeConf</code>). <code>InaccessibleAction</code>, the only experimental
|
|
2746
|
+
/// rule, is disabled by default (#2975) independently of this flag. A check on this property
|
|
2747
|
+
/// changes which results you filter, not which rules run. It will be removed in the October 2026 release.
|
|
2748
|
+
@property (nonatomic, readonly) BOOL experimental SWIFT_DEPRECATED_MSG("This flag does not determine whether a rule runs by default; it will be removed in the October 2026 release.");
|
|
2749
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
2750
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2751
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2752
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2753
|
+
@end
|
|
2754
|
+
|
|
2755
|
+
/// A set of options for when a rule is run on a view.
|
|
2756
|
+
typedef SWIFT_ENUM(NSInteger, AxeStatus, open) {
|
|
2757
|
+
/// The view was not applicable to the rule.
|
|
2758
|
+
AxeStatusINAPPLICABLE = 0,
|
|
2759
|
+
/// The view ran into an error and needs to be reviewed for accessibility manually. (Needs Review)
|
|
2760
|
+
AxeStatusINCOMPLETE = 1,
|
|
2761
|
+
/// The view does not have an accessibility issue.
|
|
2762
|
+
AxeStatusPASS = 2,
|
|
2763
|
+
/// The view has an accessibility issue.
|
|
2764
|
+
AxeStatusFAIL = 3,
|
|
2765
|
+
/// The view was not checked for accessibility issues.
|
|
2766
|
+
AxeStatusIGNORED = 4,
|
|
2767
|
+
};
|
|
2768
|
+
|
|
2769
|
+
typedef SWIFT_ENUM(NSInteger, AxeSuccessCriteria, open) {
|
|
2770
|
+
AxeSuccessCriteriaWcag412 = 0,
|
|
2771
|
+
AxeSuccessCriteriaWcag143 = 1,
|
|
2772
|
+
AxeSuccessCriteriaWcag132 = 2,
|
|
2773
|
+
AxeSuccessCriteriaWcag111 = 3,
|
|
2774
|
+
AxeSuccessCriteriaWcag144 = 4,
|
|
2775
|
+
AxeSuccessCriteriaWcag211 = 5,
|
|
2776
|
+
AxeSuccessCriteriaWcag253 = 6,
|
|
2777
|
+
AxeSuccessCriteriaWcag134 = 7,
|
|
2778
|
+
AxeSuccessCriteriaWcag242 = 8,
|
|
2779
|
+
AxeSuccessCriteriaWcag255 = 9,
|
|
2780
|
+
AxeSuccessCriteriaWcag258 = 10,
|
|
2781
|
+
AxeSuccessCriteriaWcag131 = 11,
|
|
2782
|
+
AxeSuccessCriteriaUnknown = -1,
|
|
2783
|
+
};
|
|
2784
|
+
|
|
2785
|
+
/// One team membership of the actor driving this process.
|
|
2786
|
+
/// The same type carries a team from walnut’s API-key validate response, through
|
|
2787
|
+
/// <code>AxeClient.analyticsTeams</code>, onto the usage service body and the Amplitude event. Mirroring
|
|
2788
|
+
/// walnut’s <code>{ id, name }</code> shape end to end means nothing in the chain translates it,
|
|
2789
|
+
/// so a team stamped on an event is what walnut reported, minus anything
|
|
2790
|
+
/// <code>AxeTeams.sanitize(_:)</code> refused to send (#3130).
|
|
2791
|
+
/// <code>@objc</code>-bridged because the injection entry point (<code>AxeTeams.setTeams(_:)</code>) is, and
|
|
2792
|
+
/// Objective-C cannot see a Swift struct.
|
|
2793
|
+
/// <code>@unchecked Sendable</code> rather than <code>Sendable</code>: every stored property is an immutable
|
|
2794
|
+
/// <code>String</code>, but the compiler cannot infer that through the non-<code>Sendable</code> <code>NSObject</code>
|
|
2795
|
+
/// superclass the <code>@objc</code> bridge requires. Instances cross threads, since a host can
|
|
2796
|
+
/// inject them from any thread and they are read on whichever thread sends an event.
|
|
2797
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI7AxeTeam")
|
|
2798
|
+
@interface AxeTeam : NSObject
|
|
2799
|
+
/// Walnut’s team id. Stable across renames, so this is what attribution keys on.
|
|
2800
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull id;
|
|
2801
|
+
/// Display name at the time the event was sent. Mutable on walnut’s side, which is
|
|
2802
|
+
/// why <code>id</code> and not this is the identity.
|
|
2803
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull name;
|
|
2804
|
+
- (nonnull instancetype)initWithId:(NSString * _Nonnull)id name:(NSString * _Nonnull)name OBJC_DESIGNATED_INITIALIZER;
|
|
2805
|
+
/// Suppresses the <code>init()</code> the <code>@objc</code>/<code>NSObject</code> bridge would otherwise publish.
|
|
2806
|
+
/// <code>id</code> and <code>name</code> are non-optional with no defaults, so a bridged <code>-init</code> could only
|
|
2807
|
+
/// produce an unusable instance; an Objective-C caller must use <code>initWithId:name:</code>.
|
|
2808
|
+
/// Carries a body, unlike the empty <code>{}</code> on <code>AxeTeams</code> and <code>AxeIntegration</code>: those are
|
|
2809
|
+
/// static namespaces with no stored properties, so an empty body compiles. Here it does
|
|
2810
|
+
/// not, because <code>id</code> and <code>name</code> would be left uninitialized.
|
|
2811
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2812
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2813
|
+
/// Value semantics for a value-shaped type: without this, <code>NSObject</code>’s identity
|
|
2814
|
+
/// comparison would report two teams carrying the same id and name as different.
|
|
2815
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2816
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
2817
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
2818
|
+
@end
|
|
2819
|
+
|
|
2820
|
+
/// The host-injection channel for the actor’s team memberships, which are stamped onto
|
|
2821
|
+
/// every usage service and Amplitude event so MAU reporting can slice by team without a
|
|
2822
|
+
/// later join against billing-service (#3130).
|
|
2823
|
+
/// Teams reach an event from one of two places, and the split matters:
|
|
2824
|
+
/// <ol>
|
|
2825
|
+
/// <li>
|
|
2826
|
+
/// <em>Login</em>, which is <em>not</em> stored here. <code>AxeClient</code> keeps the teams walnut returned
|
|
2827
|
+
/// for its own session on the client itself, beside <code>analyticsUserId</code> and
|
|
2828
|
+
/// <code>analyticsOrgName</code>, and hands them to <code>Amplitude</code> and <code>UsageServiceClient</code> when it
|
|
2829
|
+
/// constructs them. Keeping them per client is what stops two live <code>AxeDevTools</code>
|
|
2830
|
+
/// instances (a host’s own session and <code>AutoScanManager</code>‘s, say) from stamping each
|
|
2831
|
+
/// other’s teams onto their events.
|
|
2832
|
+
/// </li>
|
|
2833
|
+
/// <li>
|
|
2834
|
+
/// <em>Injection</em>, which is stored here, because it is genuinely process-wide: a host
|
|
2835
|
+
/// app calling <code>setTeams(_:)</code> is asserting who is signed in <em>right now</em>, not speaking
|
|
2836
|
+
/// for one client. An injected value therefore overrides the login value on every
|
|
2837
|
+
/// client until a login supersedes it.
|
|
2838
|
+
/// </li>
|
|
2839
|
+
/// </ol>
|
|
2840
|
+
/// An injection outlives any one SDK session and is cleared only by the host replacing
|
|
2841
|
+
/// it, because only the host knows when its own session changed. A login deliberately
|
|
2842
|
+
/// does not clear it: with more than one live client (a host’s own session and
|
|
2843
|
+
/// <code>AutoScanManager</code>‘s, say) one client’s login would otherwise wipe an injection that
|
|
2844
|
+
/// belongs to another. A host that logs out injects an empty array, which is honoured.
|
|
2845
|
+
/// Reads never throw and never block on a lookup: an unknown actor sends <code>teams: []</code>
|
|
2846
|
+
/// rather than dropping an MAU-qualifying event over an optional dimension.
|
|
2847
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI8AxeTeams")
|
|
2848
|
+
@interface AxeTeams : NSObject
|
|
2849
|
+
/// Replaces the team memberships stamped on subsequent events, for every client in
|
|
2850
|
+
/// this process.
|
|
2851
|
+
/// Intended for a host app that drives the SDK in-process and owns its own login
|
|
2852
|
+
/// session, which outlives any one SDK session. Call it on every session change,
|
|
2853
|
+
/// including logout, where the correct value is an empty array. An injected empty
|
|
2854
|
+
/// array means “this user has no teams” and is honoured; it does not fall back to
|
|
2855
|
+
/// whatever a login found.
|
|
2856
|
+
/// Shipped on iOS for API parity with Android, where the Analyzer is the caller. No
|
|
2857
|
+
/// in-process iOS host uses it today: everything reaching this SDK arrives through
|
|
2858
|
+
/// Appium, and a fresh session there means a fresh fetch. In <code>axeDevToolsXCUI_noauth</code>,
|
|
2859
|
+
/// which compiles without analytics, nothing reads this value and no events are sent;
|
|
2860
|
+
/// it ships there for API-surface parity only.
|
|
2861
|
+
/// Entries are dropped rather than sent, and the rest of the array still applies, when
|
|
2862
|
+
/// the id is blank, when either field carries control characters, or when either field
|
|
2863
|
+
/// exceeds 256 unicode scalars. Past 100 entries the array is truncated. Every drop is
|
|
2864
|
+
/// logged. A blank <em>name</em> is kept: the id is the identity.
|
|
2865
|
+
/// \param teams The actor’s current team memberships. Pass an empty array to clear.
|
|
2866
|
+
///
|
|
2867
|
+
+ (void)setTeams:(NSArray<AxeTeam *> * _Nonnull)teams;
|
|
2868
|
+
/// Suppresses the <code>init()</code> the <code>@objc</code>/<code>NSObject</code> bridge would otherwise publish on a
|
|
2869
|
+
/// type that is a namespace for static members, matching <code>AxeIntegration</code>.
|
|
2870
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
2871
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2872
|
+
@end
|
|
2873
|
+
|
|
2874
|
+
/// The accessibility traits on a view. Similar to UIAccessibilityTraits.
|
|
2875
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeTraits")
|
|
2876
|
+
@interface AxeTraits : NSObject
|
|
2877
|
+
@property (nonatomic) uint64_t rawValue;
|
|
2878
|
+
@property (nonatomic, readonly) NSUInteger hash;
|
|
2879
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
2880
|
+
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
2881
|
+
- (nonnull instancetype)initWithRawValue:(uint64_t)raw OBJC_DESIGNATED_INITIALIZER;
|
|
2882
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2883
|
+
- (void)formUnion:(AxeTraits * _Nonnull)other;
|
|
2884
|
+
- (void)formIntersection:(AxeTraits * _Nonnull)other;
|
|
2885
|
+
- (void)formSymmetricDifference:(AxeTraits * _Nonnull)other;
|
|
2886
|
+
/// Same as UIAccessibilityTraits.adjustable
|
|
2887
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull adjustable;)
|
|
2888
|
+
+ (AxeTraits * _Nonnull)adjustable SWIFT_WARN_UNUSED_RESULT;
|
|
2889
|
+
/// Same as UIAccessibilityTraits.allowsDirectInteraction
|
|
2890
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull allowsDirectInteraction;)
|
|
2891
|
+
+ (AxeTraits * _Nonnull)allowsDirectInteraction SWIFT_WARN_UNUSED_RESULT;
|
|
2892
|
+
/// Same as UIAccessibilityTraits.button
|
|
2893
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull button;)
|
|
2894
|
+
+ (AxeTraits * _Nonnull)button SWIFT_WARN_UNUSED_RESULT;
|
|
2895
|
+
/// Same as UIAccessibilityTraits.causesPageTurn
|
|
2896
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull causesPageTurn;)
|
|
2897
|
+
+ (AxeTraits * _Nonnull)causesPageTurn SWIFT_WARN_UNUSED_RESULT;
|
|
2898
|
+
/// Same as UIAccessibilityTraits.header
|
|
2899
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull header;)
|
|
2900
|
+
+ (AxeTraits * _Nonnull)header SWIFT_WARN_UNUSED_RESULT;
|
|
2901
|
+
/// Same as UIAccessibilityTraits.image
|
|
2902
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull image;)
|
|
2903
|
+
+ (AxeTraits * _Nonnull)image SWIFT_WARN_UNUSED_RESULT;
|
|
2904
|
+
/// Same as UIAccessibilityTraits.keyboardKey
|
|
2905
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull keyboardKey;)
|
|
2906
|
+
+ (AxeTraits * _Nonnull)keyboardKey SWIFT_WARN_UNUSED_RESULT;
|
|
2907
|
+
/// Same as UIAccessibilityTraits.link
|
|
2908
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull link;)
|
|
2909
|
+
+ (AxeTraits * _Nonnull)link SWIFT_WARN_UNUSED_RESULT;
|
|
2910
|
+
/// Same as UIAccessibilityTraits.none
|
|
2911
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull none;)
|
|
2912
|
+
+ (AxeTraits * _Nonnull)none SWIFT_WARN_UNUSED_RESULT;
|
|
2913
|
+
/// Same as UIAccessibilityTraits.notEnabled
|
|
2914
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull notEnabled;)
|
|
2915
|
+
+ (AxeTraits * _Nonnull)notEnabled SWIFT_WARN_UNUSED_RESULT;
|
|
2916
|
+
/// Same as UIAccessibilityTraits.playsSound
|
|
2917
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull playsSound;)
|
|
2918
|
+
+ (AxeTraits * _Nonnull)playsSound SWIFT_WARN_UNUSED_RESULT;
|
|
2919
|
+
/// Same as UIAccessibilityTraits.searchField
|
|
2920
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull searchField;)
|
|
2921
|
+
+ (AxeTraits * _Nonnull)searchField SWIFT_WARN_UNUSED_RESULT;
|
|
2922
|
+
/// Same as UIAccessibilityTraits.selected
|
|
2923
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull selected;)
|
|
2924
|
+
+ (AxeTraits * _Nonnull)selected SWIFT_WARN_UNUSED_RESULT;
|
|
2925
|
+
/// Same as UIAccessibilityTraits.startsMediaSession
|
|
2926
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull startsMediaSession;)
|
|
2927
|
+
+ (AxeTraits * _Nonnull)startsMediaSession SWIFT_WARN_UNUSED_RESULT;
|
|
2928
|
+
/// Same as UIAccessibilityTraits.staticText
|
|
2929
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull staticText;)
|
|
2930
|
+
+ (AxeTraits * _Nonnull)staticText SWIFT_WARN_UNUSED_RESULT;
|
|
2931
|
+
/// Same as UIAccessibilityTraits.summaryElement
|
|
2932
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull summaryElement;)
|
|
2933
|
+
+ (AxeTraits * _Nonnull)summaryElement SWIFT_WARN_UNUSED_RESULT;
|
|
2934
|
+
/// Same as UIAccessibilityTraits.tabBar
|
|
2935
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull tabBar;)
|
|
2936
|
+
+ (AxeTraits * _Nonnull)tabBar SWIFT_WARN_UNUSED_RESULT;
|
|
2937
|
+
/// Same as UIAccessibilityTraits.updatesFrequently
|
|
2938
|
+
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AxeTraits * _Nonnull updatesFrequently;)
|
|
2939
|
+
+ (AxeTraits * _Nonnull)updatesFrequently SWIFT_WARN_UNUSED_RESULT;
|
|
2940
|
+
/// Converts an AxeTrait into an easily readable String.
|
|
2941
|
+
///
|
|
2942
|
+
/// returns:
|
|
2943
|
+
/// The name of the AxeTrait. If there are multiple traits within an AxeTraits object, the traits will be in a comma-separated String. For example, <code>(.button | .adjustable).toString()</code> would return <code>Adjustable, Button</code>.
|
|
2944
|
+
- (NSString * _Nonnull)toString SWIFT_WARN_UNUSED_RESULT;
|
|
2945
|
+
@end
|
|
2946
|
+
|
|
2947
|
+
/// Who triggered a scan session, for MAU reporting.
|
|
2948
|
+
/// <code>@objc</code>-bridged so a typo in an Objective-C caller is a build failure, not a silently
|
|
2949
|
+
/// wrong value. Both the <code>Int</code> raw values (the Objective-C bridge exposes them by ordinal)
|
|
2950
|
+
/// and <code>wireValue</code> are published contracts: append only, never renumber or reword.
|
|
2951
|
+
typedef SWIFT_ENUM(NSInteger, AxeUsageActor, open) {
|
|
2952
|
+
AxeUsageActorHuman = 0,
|
|
2953
|
+
AxeUsageActorAutomation = 1,
|
|
2954
|
+
};
|
|
2955
|
+
|
|
2956
|
+
SWIFT_ENUM_FWD_DECL(NSInteger, RunStatus)
|
|
2957
|
+
/// A class representing one view in a view hierarchy.
|
|
2958
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI7AxeView")
|
|
2959
|
+
@interface AxeView : NSObject
|
|
2960
|
+
/// name of the original class, as a String (UIButton, UIWindow, DQButton, etc).
|
|
2961
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull className;
|
|
2962
|
+
/// the type of object. We use this to help determine whether a rule should be run on a specific view. AxeElementTypes are derived from XCUIElement <code>ElementType</code>.
|
|
2963
|
+
@property (nonatomic, readonly) enum AxeElementType elementType;
|
|
2964
|
+
/// the view’s on-screen coordinates, in pixels (not pt).
|
|
2965
|
+
@property (nonatomic, readonly, strong) AxeBounds * _Nonnull boundsInScreen;
|
|
2966
|
+
/// the view’s accessibility identifier.
|
|
2967
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable accessibilityIdentifier;
|
|
2968
|
+
/// the view’s accessible name. This is usually equivalent to the view’s accessibilityLabel or its visible text. Will be <code>nil</code> if the view is not focusable by VoiceOver.
|
|
2969
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable name;
|
|
2970
|
+
/// the type of the view. See <code>AxeRole</code> for more information.
|
|
2971
|
+
@property (nonatomic, readonly) enum AxeRole role;
|
|
2972
|
+
/// the view’s state, if it has one. Will be <code>nil</code> if the view is not a control.
|
|
2973
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable state;
|
|
2974
|
+
/// the view’s value, if it has one. Will be <code>nil</code> if the view does not have a changeable value. Switches, sliders, steppers, etc, all have values.
|
|
2975
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable value;
|
|
2976
|
+
/// whether a view can be directly focused by VoiceOver. This property is calculated from isAccessibilityElement, and will be false for any child views within a VoiceOver-focusable view.
|
|
2977
|
+
@property (nonatomic, readonly) BOOL isAccessibilityFocusable;
|
|
2978
|
+
/// The view’s subviews, as AxeViews
|
|
2979
|
+
@property (nonatomic, readonly, copy) NSArray<AxeView *> * _Nonnull children;
|
|
2980
|
+
/// The view’s parent, as an AxeView.
|
|
2981
|
+
@property (nonatomic, weak) AxeView * _Nullable parent;
|
|
2982
|
+
/// Detected text from the VisionAPI
|
|
2983
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable detectedText;
|
|
2984
|
+
/// a unique identifier for the view. The axeViewId will change between scans of the same view.
|
|
2985
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull axeViewId;
|
|
2986
|
+
/// whether a view can be seen on-screen at the time of the scan. Will return false if the view is off-screen or behind a modal or other views (such as a tab bar or a navigation bar) or if it is partially off-screen.
|
|
2987
|
+
@property (nonatomic, readonly) BOOL isVisibleToUser;
|
|
2988
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
2989
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2990
|
+
/// Runs through the view hierarchy in a depth-first search, with the view that this method was called on as the “root” view.
|
|
2991
|
+
/// \param function The function that should be run on the view hierarchy.
|
|
2992
|
+
///
|
|
2993
|
+
///
|
|
2994
|
+
/// returns:
|
|
2995
|
+
/// Whether to continue running through the view hierarchy. See <code>RunStatus</code> for more information.
|
|
2996
|
+
- (enum RunStatus)runOnSelfAndDescendants:(SWIFT_NOESCAPE enum RunStatus (^ _Nonnull)(AxeView * _Nonnull))function;
|
|
2997
|
+
/// Runs through the view hierarchy in a depth-first search, with the view that this method was called on as the “root” view.
|
|
2998
|
+
/// \param function The function that should be run on the view hierarchy.
|
|
2999
|
+
///
|
|
3000
|
+
///
|
|
3001
|
+
/// returns:
|
|
3002
|
+
/// Always returns <code>Stop</code> as the children have finished parsing; See <code>RunStatus</code> for more information.
|
|
3003
|
+
- (enum RunStatus)runOnDescendants:(SWIFT_NOESCAPE enum RunStatus (^ _Nonnull)(AxeView * _Nonnull))function;
|
|
3004
|
+
/// Finds whether the view’s provided property is true or has an ancestor whose provided property is true.
|
|
3005
|
+
/// important:
|
|
3006
|
+
/// <code>propName</code> must be the name of a property that is a <code>Bool</code>. If it is not, this method will log an error into the console and automatically return false.
|
|
3007
|
+
/// \param propName a property that is a <code>Bool</code> that the view or an ancestor of the view may have set to true.
|
|
3008
|
+
///
|
|
3009
|
+
///
|
|
3010
|
+
/// returns:
|
|
3011
|
+
/// true if the view’s property is true or is a child of a view whose provided property is true; false otherwise.
|
|
3012
|
+
- (BOOL)isPropTypeOrChildOfProp:(NSString * _Nonnull)propName SWIFT_WARN_UNUSED_RESULT;
|
|
3013
|
+
/// Finds whether the view has an ancestor whose provided property is true.
|
|
3014
|
+
/// important:
|
|
3015
|
+
/// <code>propName</code> must be the name of a property that is a <code>Bool</code>. If it is not, this method will log an error into the console and automatically return false.
|
|
3016
|
+
/// \param propName a property that is a <code>Bool</code> that an ancestor of the view may have set to true.
|
|
3017
|
+
///
|
|
3018
|
+
///
|
|
3019
|
+
/// returns:
|
|
3020
|
+
/// true if the view is a child of a view whose provided property is true; false otherwise.
|
|
3021
|
+
- (BOOL)isChildOfProp:(NSString * _Nonnull)propName SWIFT_WARN_UNUSED_RESULT;
|
|
3022
|
+
/// Checks whether an ancestor of this view is of the elementType provided.
|
|
3023
|
+
/// \param elementType the type that the ancestor may be.
|
|
3024
|
+
///
|
|
3025
|
+
///
|
|
3026
|
+
/// returns:
|
|
3027
|
+
/// true if the view is a child of the elementType provided, otherwise false.
|
|
3028
|
+
- (BOOL)isChildOfElementType:(enum AxeElementType)elementType SWIFT_WARN_UNUSED_RESULT;
|
|
3029
|
+
/// Finds whether the view is of the elementType provided, or if the view has an ancestor that is of the elementType provided.
|
|
3030
|
+
/// \param elementType the type that the view or an ancestor of the view may be.
|
|
3031
|
+
///
|
|
3032
|
+
///
|
|
3033
|
+
/// returns:
|
|
3034
|
+
/// true if the view is the elementType provided or if it is a child of the elementType provided; false otherwise.
|
|
3035
|
+
- (BOOL)isElementOrChildOfElementType:(enum AxeElementType)elementType SWIFT_WARN_UNUSED_RESULT;
|
|
3036
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
3037
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
3038
|
+
@end
|
|
3039
|
+
|
|
3040
|
+
/// Attempts to identify the type of app that we are testing against
|
|
3041
|
+
typedef SWIFT_ENUM(NSInteger, AxeViewHierarchy, open) {
|
|
3042
|
+
AxeViewHierarchyUIKit = 0,
|
|
3043
|
+
AxeViewHierarchySwiftUI = 1,
|
|
3044
|
+
AxeViewHierarchyReactNative = 2,
|
|
3045
|
+
AxeViewHierarchyFlutter = 3,
|
|
3046
|
+
};
|
|
3047
|
+
|
|
3048
|
+
/// An object that holds information about the rule, including a brief description, the severity of a failure of the rule, and whether the rule is classified as a WCAG Success Criteria.
|
|
3049
|
+
SWIFT_CLASS("_TtC15axeDevToolsXCUI8RuleConf")
|
|
3050
|
+
@interface RuleConf : NSObject
|
|
3051
|
+
/// Whether a rule is currently experimental or not.
|
|
3052
|
+
/// Deprecated. This flag does not determine whether a rule runs by default — that is decided by
|
|
3053
|
+
/// each rule’s own <code>ignored</code> default (see <code>AxeConf</code>). <code>InaccessibleAction</code>, the only experimental
|
|
3054
|
+
/// rule, is disabled by default (#2975) independently of this flag. A check on this property
|
|
3055
|
+
/// changes which results you filter, not which rules run. It will be removed in the October 2026 release.
|
|
3056
|
+
@property (nonatomic, readonly) BOOL experimental SWIFT_DEPRECATED_MSG("This flag does not determine whether a rule runs by default; it will be removed in the October 2026 release.");
|
|
3057
|
+
/// A brief description of the rule.
|
|
3058
|
+
@property (nonatomic, readonly, copy) NSString * _Nonnull summary;
|
|
3059
|
+
/// The severity of a failure of the rule. See <code>AxeImpact</code> for more information.
|
|
3060
|
+
@property (nonatomic, readonly) enum AxeImpact impact;
|
|
3061
|
+
@property (nonatomic, readonly, copy) NSString * _Nullable ruleId;
|
|
3062
|
+
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
3063
|
+
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
3064
|
+
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
3065
|
+
@end
|
|
3066
|
+
|
|
3067
|
+
/// Whether the view hierarchy should continue to be traversed.
|
|
3068
|
+
typedef SWIFT_ENUM(NSInteger, RunStatus, open) {
|
|
3069
|
+
/// The view hierarchy should continue to be traversed.
|
|
3070
|
+
RunStatusContinue = 0,
|
|
3071
|
+
/// The view hierarchy should no longer be traversed and will immediately stop at this point.
|
|
3072
|
+
RunStatusStop = 1,
|
|
3073
|
+
/// The view hierarchy should continue to be traversed along siblings of this view and their descendants, but should not traverse through child elements of this view.
|
|
3074
|
+
RunStatusSkipDescendants = 2,
|
|
3075
|
+
};
|
|
3076
|
+
|
|
3077
|
+
#endif // defined(__OBJC__)
|
|
3078
|
+
#if __has_attribute(external_source_symbol)
|
|
3079
|
+
# pragma clang attribute pop
|
|
3080
|
+
#endif
|
|
3081
|
+
#if defined(__cplusplus)
|
|
3082
|
+
#endif
|
|
3083
|
+
#pragma clang diagnostic pop
|
|
3084
|
+
#endif
|
|
3085
|
+
|
|
3086
|
+
#else
|
|
3087
|
+
#error unsupported Swift architecture
|
|
3088
|
+
#endif
|