@deque/axe-appium3-webdriveragent 1.7.1 → 2.0.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/README.md +1 -1
- package/WebDriverAgent.xcodeproj/project.pbxproj +61 -3
- package/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.h +4 -1
- package/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.m +35 -2
- package/WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.h +6 -0
- package/WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.m +100 -23
- package/WebDriverAgentLib/Categories/XCUIDevice+FBRotation.m +8 -3
- package/WebDriverAgentLib/Categories/XCUIElement+FBTyping.h +7 -0
- package/WebDriverAgentLib/Categories/XCUIElement+FBTyping.m +20 -0
- package/WebDriverAgentLib/Commands/AxeAuthCommands.h +4 -0
- package/WebDriverAgentLib/Commands/AxeAuthCommands.m +113 -56
- package/WebDriverAgentLib/Commands/AxeAutoScanCommands.m +1 -7
- package/WebDriverAgentLib/Commands/AxeScanCommands.m +57 -315
- package/WebDriverAgentLib/Commands/FBCustomCommands.m +8 -0
- package/WebDriverAgentLib/Commands/FBElementCommands.m +12 -5
- package/WebDriverAgentLib/Commands/FBSessionCommands.m +1 -1
- package/WebDriverAgentLib/Info.plist +2 -2
- package/WebDriverAgentLib/Routing/FBSession.m +2 -2
- package/WebDriverAgentLib/Utilities/FBConfiguration.h +2 -0
- package/WebDriverAgentLib/Utilities/FBConfiguration.m +1 -0
- package/WebDriverAgentLib/Utilities/FBHIDOperations.h +41 -0
- package/WebDriverAgentLib/Utilities/FBHIDOperations.m +244 -0
- package/WebDriverAgentLib/Utilities/FBSettings.h +1 -0
- package/WebDriverAgentLib/Utilities/FBSettings.m +1 -0
- package/WebDriverAgentLib/Utilities/FBSettingsHandler.m +26 -2
- package/WebDriverAgentTests/IntegrationApp/Classes/ViewController.m +11 -7
- package/WebDriverAgentTests/IntegrationTests/FBElementAttributeTests.m +44 -0
- package/WebDriverAgentTests/IntegrationTests/FBTypingTest.m +33 -0
- package/WebDriverAgentTests/IntegrationTests/XCUIApplicationHelperTests.m +111 -0
- package/WebDriverAgentTests/IntegrationTests/XCUIDeviceHelperTests.m +97 -0
- package/WebDriverAgentTests/IntegrationTests/XCUIDeviceRotationTests.m +53 -0
- package/WebDriverAgentTests/IntegrationTests_tvOS/FBTVFocusIntegrationTests.m +21 -0
- package/WebDriverAgentTests/IntegrationTests_watchOS/WDAAppLifecycleIntegrationTests.swift +12 -0
- package/axeDevToolsXCUI.xcframework/Info.plist +3 -3
- package/axeDevToolsXCUI.xcframework/LICENSE-3RD-PARTY-axe-devtools-ios.md +1 -1
- package/axeDevToolsXCUI.xcframework/{axe-devtools-ios-4.3.1.cdx.json → axe-devtools-ios-5.0.0.cdx.json} +6 -6
- package/axeDevToolsXCUI.xcframework/{axe-devtools-ios-4.3.1.spdx.json → axe-devtools-ios-5.0.0.spdx.json} +5 -5
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Headers/AxeTestBundleObserver.h +0 -1
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Headers/axeDevToolsXCUI-Swift.h +82 -228
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Info.plist +4 -4
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios.abi.json +3120 -5759
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios.private.swiftinterface +53 -168
- 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 +53 -168
- package/axeDevToolsXCUI.xcframework/ios-arm64/axeDevToolsXCUI.framework/axeDevToolsXCUI +0 -0
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Headers/AxeTestBundleObserver.h +0 -1
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Headers/axeDevToolsXCUI-Swift.h +164 -456
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Info.plist +4 -4
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios-simulator.abi.json +3120 -5759
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface +53 -168
- 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 +53 -168
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/x86_64-apple-ios-simulator.abi.json +3120 -5759
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/Modules/axeDevToolsXCUI.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface +53 -168
- 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 +53 -168
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/_CodeSignature/CodeResources +25 -25
- package/axeDevToolsXCUI.xcframework/ios-arm64_x86_64-simulator/axeDevToolsXCUI.framework/axeDevToolsXCUI +0 -0
- package/build/lib/webdriveragent.d.ts.map +1 -1
- package/build/lib/webdriveragent.js +1 -2
- package/build/lib/webdriveragent.js.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/lib/webdriveragent.ts +1 -2
- package/package.json +8 -10
|
@@ -379,7 +379,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AutoScanMana
|
|
|
379
379
|
+ (AutoScanManager * _Nonnull)shared SWIFT_WARN_UNUSED_RESULT;
|
|
380
380
|
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
381
381
|
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
382
|
-
|
|
382
|
+
/// Called from WDA: authenticates and configures AutoScanManager without reading from axe_config.json.
|
|
383
|
+
///
|
|
384
|
+
/// throws:
|
|
385
|
+
/// An error if <code>axeAccountUrl</code> is not an https URL (pass an empty string for Deque’s
|
|
386
|
+
/// server), if the API key or projectId is invalid, or if authentication fails.
|
|
387
|
+
- (BOOL)enableWithBundleId:(NSString * _Nonnull)bundleId apiKey:(NSString * _Nonnull)apiKey axeAccountUrl:(NSString * _Nonnull)axeAccountUrl projectId:(NSString * _Nonnull)projectId uploadToDashboard:(BOOL)uploadToDashboard htmlReportPath:(NSString * _Nullable)htmlReportPath error:(NSError * _Nullable * _Nullable)error;
|
|
383
388
|
/// Captures the current screen state without requiring a gesture trigger.
|
|
384
389
|
/// Called from WDA after enable() to capture the initial screen.
|
|
385
390
|
- (void)captureInitialContext;
|
|
@@ -442,44 +447,17 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeBounds")
|
|
|
442
447
|
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
443
448
|
@end
|
|
444
449
|
|
|
445
|
-
/// The configuration
|
|
446
|
-
/// By default, all <code>AxeRule</code>s
|
|
450
|
+
/// The rule configuration a scan ran with, exposed on <code>AxeResult.axeConf</code>.
|
|
451
|
+
/// By default, all <code>AxeRule</code>s run. To ignore rules or add custom rules, use
|
|
452
|
+
/// <code>AxeDevTools.ignoreRules(_:)</code> and <code>AxeDevTools.addCustomRule(_:)</code>.
|
|
447
453
|
SWIFT_CLASS("_TtC15axeDevToolsXCUI7AxeConf")
|
|
448
454
|
@interface AxeConf : NSObject
|
|
449
455
|
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
450
456
|
/// 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
457
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
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.");
|
|
458
|
+
- (void)ignoreWithRule:(NSString * _Nonnull)rule :(BOOL)shouldIgnore SWIFT_UNAVAILABLE_MSG("'ignore' has been renamed to 'AxeDevTools.ignoreRules(_:)': Ignore built-in rules with typed values, e.g. axe.ignoreRules(.colorContrast). Ignoring a custom rule and switching a rule back on were removed. See the October 2026 migration note.");
|
|
459
|
+
- (void)ignoreWithRules:(NSArray<NSString *> * _Nonnull)rules :(BOOL)shouldIgnore SWIFT_UNAVAILABLE_MSG("'ignore' has been renamed to 'AxeDevTools.ignoreRules(_:)': Ignore built-in rules with typed values, e.g. axe.ignoreRules(.colorContrast, .screenTitle). Ignoring a custom rule and switching a rule back on were removed. See the October 2026 migration note.");
|
|
460
|
+
- (void)ignoreWithRulesFor:(NSDictionary<NSString *, NSSet<NSString *> *> * _Nonnull)rulesFor SWIFT_UNAVAILABLE_MSG("'ignore' has been renamed to 'AxeDevTools.ignoreRules(onElementWithId:_:)': Use axe.ignoreRules(onElementWithId:_:) for an accessibility identifier or axe.ignoreRules(onElementOfClass:_:) for a class name. See the October 2026 migration note.");
|
|
483
461
|
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
484
462
|
@end
|
|
485
463
|
|
|
@@ -503,7 +481,6 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI10AxeContext")
|
|
|
503
481
|
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
504
482
|
@end
|
|
505
483
|
|
|
506
|
-
@class AxeDevToolsResultKey;
|
|
507
484
|
@class AxeResult;
|
|
508
485
|
/// AxeDevTools class contains many static methods for you to set up testing for accessibility.
|
|
509
486
|
/// With this class, you can:
|
|
@@ -520,68 +497,21 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI10AxeContext")
|
|
|
520
497
|
/// </ul>
|
|
521
498
|
SWIFT_CLASS("_TtC15axeDevToolsXCUI11AxeDevTools")
|
|
522
499
|
@interface AxeDevTools : NSObject
|
|
523
|
-
///
|
|
524
|
-
///
|
|
525
|
-
|
|
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.");
|
|
500
|
+
/// Removed in the October 2026 release. Rules are ignored and custom rules registered on
|
|
501
|
+
/// <code>AxeDevTools</code> itself.
|
|
502
|
+
@property (nonatomic, readonly, strong) AxeConf * _Nonnull configuration SWIFT_UNAVAILABLE_MSG("Use axe.ignoreRules(...) to ignore rules and axe.addCustomRule(_:) to register a custom rule. See the October 2026 migration note.");
|
|
528
503
|
/// Set this property to <code>true</code> if you want additional debug information for unexpected behavior.
|
|
529
504
|
/// We may request this to be turned on if an obscure bug is found.
|
|
530
505
|
SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
531
506
|
+ (BOOL)debugStatements SWIFT_WARN_UNUSED_RESULT;
|
|
532
507
|
+ (void)setDebugStatements:(BOOL)value;
|
|
533
508
|
@property (nonatomic, readonly, copy) NSString * _Nullable sessionId;
|
|
534
|
-
///
|
|
535
|
-
/// \param
|
|
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.
|
|
509
|
+
/// Use this after calling <code>run</code> to send the scan to the Developer Hub. Will throw an error if sending the scan was not successful.
|
|
510
|
+
/// \param result The result that should be pushed to the Developer Hub.
|
|
556
511
|
///
|
|
557
|
-
/// \param
|
|
512
|
+
/// \param scanName A String to change the scan name to in the Developer Hub.
|
|
558
513
|
///
|
|
559
|
-
|
|
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.");
|
|
514
|
+
- (BOOL)postResult:(AxeResult * _Nonnull)result withScanName:(NSString * _Nullable)scanName error:(NSError * _Nullable * _Nullable)error;
|
|
585
515
|
/// Utilize this API with your result from calling <code>run</code> and save your accessibility results locally to your machine as JSON.
|
|
586
516
|
/// \param result The AxeResult object returned from the <code>run</code> API.
|
|
587
517
|
///
|
|
@@ -651,72 +581,17 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
651
581
|
- (AxeReportResult * _Nullable)generateHtmlReportAndSummaryWithOutputPath:(NSString * _Nullable)outputPath error:(NSError * _Nullable * _Nullable)error;
|
|
652
582
|
@end
|
|
653
583
|
|
|
584
|
+
@class NSURL;
|
|
585
|
+
@interface AxeDevTools (SWIFT_EXTENSION(axeDevToolsXCUI))
|
|
586
|
+
/// A link to this project’s page in Axe Developer Hub, which lists the project’s recent runs.
|
|
587
|
+
/// The SDK logs it after each successful targeted upload; an AutoScan run logs a link to its
|
|
588
|
+
/// own session instead. Nil when the session does not upload results, for example one
|
|
589
|
+
/// started with <code>authenticate</code>, <code>loginWithAccessToken</code>, or <code>startScanSession</code> with
|
|
590
|
+
/// <code>axeUploadResults: false</code>.
|
|
591
|
+
@property (nonatomic, readonly, copy) NSURL * _Nullable devHubResultsURL;
|
|
592
|
+
@end
|
|
593
|
+
|
|
654
594
|
@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
595
|
/// Starts a session with the axeDevTools cloud instance using an API key and project ID.
|
|
721
596
|
/// This is the recommended method to initialize axeDevTools for accessibility testing. A valid session is required before utilizing the framework’s features.
|
|
722
597
|
/// <ul>
|
|
@@ -724,12 +599,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
724
599
|
/// For Objective-C, pass in an empty String to the <code>axeAccountUrl</code> parameter and the default server will be used.
|
|
725
600
|
/// </li>
|
|
726
601
|
/// <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.
|
|
602
|
+
/// Will throw an error if <code>axeAccountUrl</code> is not an https URL, if the API key or projectId is not valid, or if <code>axeUploadResults</code> is true and no <code>projectId</code> was supplied.
|
|
728
603
|
/// </li>
|
|
729
604
|
/// </ul>
|
|
730
605
|
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
731
606
|
///
|
|
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).
|
|
607
|
+
/// \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, and must be an https URL. Defaults to empty string (uses default server).
|
|
733
608
|
///
|
|
734
609
|
/// \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
610
|
///
|
|
@@ -737,7 +612,7 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
737
612
|
///
|
|
738
613
|
///
|
|
739
614
|
/// 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.
|
|
615
|
+
/// An error if either <code>axeUploadResults</code> is true and <code>projectId</code> is absent or empty, if <code>axeAccountUrl</code> is not an https URL, or if the API key or projectId is invalid or authentication fails.
|
|
741
616
|
///
|
|
742
617
|
/// returns:
|
|
743
618
|
/// An instantiated AxeDevTools object ready for accessibility testing.
|
|
@@ -749,12 +624,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
749
624
|
/// For Objective-C, pass in an empty String to the <code>axeAccountUrl</code> parameter and the default server will be used.
|
|
750
625
|
/// </li>
|
|
751
626
|
/// <li>
|
|
752
|
-
/// The completion handler is called with an error if the API key is not valid.
|
|
627
|
+
/// The completion handler is called with an error if <code>axeAccountUrl</code> is not an https URL or the API key is not valid.
|
|
753
628
|
/// </li>
|
|
754
629
|
/// </ul>
|
|
755
630
|
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
756
631
|
///
|
|
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).
|
|
632
|
+
/// \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, and must be an https URL. Defaults to empty string (uses default server).
|
|
758
633
|
///
|
|
759
634
|
/// \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
635
|
///
|
|
@@ -769,13 +644,13 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
769
644
|
/// with <code>axeUploadResults</code> set to <code>NO</code>.
|
|
770
645
|
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
771
646
|
///
|
|
772
|
-
/// \param axeAccountUrl URL of the server receiving the scans. Pass an empty string for Deque’s.
|
|
647
|
+
/// \param axeAccountUrl URL of the server receiving the scans; must be an https URL. Pass an empty string for Deque’s.
|
|
773
648
|
///
|
|
774
649
|
/// \param projectId The project ID for uploading results to Axe Developer Hub.
|
|
775
650
|
///
|
|
776
651
|
///
|
|
777
652
|
/// throws:
|
|
778
|
-
/// An error if the API key or projectId is invalid, or authentication fails.
|
|
653
|
+
/// An error if <code>axeAccountUrl</code> is not an https URL, if the API key or projectId is invalid, or if authentication fails.
|
|
779
654
|
///
|
|
780
655
|
/// returns:
|
|
781
656
|
/// An instantiated AxeDevTools object ready for accessibility testing.
|
|
@@ -786,15 +661,16 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
786
661
|
/// Authenticates with a pre-obtained OAuth access token.
|
|
787
662
|
/// Use this when your integration already holds a valid Bearer token
|
|
788
663
|
/// (e.g., from an MCP server) and you want to run local scans without
|
|
789
|
-
/// uploading results to the Deque backend.
|
|
664
|
+
/// uploading results to the Deque backend. The account needs an axe DevTools Mobile
|
|
665
|
+
/// subscription, and the company’s rule configuration is applied.
|
|
790
666
|
/// \param accessToken A valid OAuth access token (Bearer token).
|
|
791
667
|
///
|
|
792
668
|
/// \param axeAccountUrl URL of the axe account instance. Only needed for
|
|
793
|
-
/// enterprises with their own instance. Defaults to empty string (uses default server).
|
|
669
|
+
/// enterprises with their own instance, and must be an https URL. Defaults to empty string (uses default server).
|
|
794
670
|
///
|
|
795
671
|
///
|
|
796
672
|
/// throws:
|
|
797
|
-
/// An error if the access token is invalid or authentication fails.
|
|
673
|
+
/// An error if <code>axeAccountUrl</code> is not an https URL, if the access token is invalid, if the account has no axe DevTools Mobile subscription, or if authentication fails.
|
|
798
674
|
///
|
|
799
675
|
/// returns:
|
|
800
676
|
/// An initialized AxeDevTools object ready for local scanning.
|
|
@@ -808,41 +684,50 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
808
684
|
/// </ul>
|
|
809
685
|
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
810
686
|
///
|
|
811
|
-
/// \param axeAccountUrl URL of the axe account instance. Only needed for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
687
|
+
/// \param axeAccountUrl URL of the axe account instance. Only needed for enterprises with their own instance, and must be an https URL. Defaults to empty string (uses default server).
|
|
812
688
|
///
|
|
813
689
|
///
|
|
814
690
|
/// throws:
|
|
815
|
-
/// An error if the API key is invalid or authentication fails.
|
|
691
|
+
/// An error if <code>axeAccountUrl</code> is not an https URL, if the API key is invalid, or if authentication fails.
|
|
816
692
|
///
|
|
817
693
|
/// returns:
|
|
818
694
|
/// An initialized AxeDevTools object ready for local scanning.
|
|
819
695
|
+ (AxeDevTools * _Nullable)authenticateWithApiKey:(NSString * _Nonnull)apiKey axeAccountUrl:(NSString * _Nonnull)axeAccountUrl error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
820
696
|
@end
|
|
821
697
|
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
///
|
|
827
|
-
|
|
828
|
-
///
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
///
|
|
833
|
-
///
|
|
834
|
-
///
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
///
|
|
839
|
-
///
|
|
840
|
-
///
|
|
841
|
-
///
|
|
842
|
-
- (
|
|
843
|
-
-
|
|
844
|
-
- (
|
|
845
|
-
|
|
698
|
+
SWIFT_ENUM_FWD_DECL(NSInteger, AxeRuleId)
|
|
699
|
+
@interface AxeDevTools (SWIFT_EXTENSION(axeDevToolsXCUI))
|
|
700
|
+
/// Ignores one built-in rule for every scan from this instance. Objective-C cannot pass a list of
|
|
701
|
+
/// <code>AxeRuleId</code> values, so Objective-C callers ignore rules one call at a time:
|
|
702
|
+
/// \code
|
|
703
|
+
/// [axe ignoreRule:AxeRuleIdColorContrast];
|
|
704
|
+
///
|
|
705
|
+
/// \endcodeSwift callers use <code>ignoreRules(_:)</code>.
|
|
706
|
+
- (void)ignoreRule:(enum AxeRuleId)rule;
|
|
707
|
+
/// Ignores built-in rules by their wire name (<code>AxeRuleId.toString()</code>, e.g. <code>"ColorContrast"</code>).
|
|
708
|
+
/// Exists for the Appium WebDriverAgent integration, which receives rule names as text from the
|
|
709
|
+
/// Appium driver; hidden from Swift so no Swift caller can pass a misspelled name. Names that
|
|
710
|
+
/// match no built-in rule are logged and skipped, and an empty list does nothing.
|
|
711
|
+
- (void)ignoreRulesNamed:(NSArray<NSString *> * _Nonnull)names;
|
|
712
|
+
/// Ignores one built-in rule on every element whose accessibility identifier is <code>id</code>. The
|
|
713
|
+
/// Objective-C form of <code>ignoreRules(onElementWithId:_:)</code>, called once per rule:
|
|
714
|
+
/// \code
|
|
715
|
+
/// [axe ignoreRule:AxeRuleIdColorContrast onElementWithId:@"loginButton"];
|
|
716
|
+
///
|
|
717
|
+
/// \endcode
|
|
718
|
+
- (void)ignoreRule:(enum AxeRuleId)rule onElementWithId:(NSString * _Nonnull)id;
|
|
719
|
+
/// Ignores one built-in rule on every element whose class name is exactly <code>className</code>. The
|
|
720
|
+
/// Objective-C form of <code>ignoreRules(onElementOfClass:_:)</code>, called once per rule.
|
|
721
|
+
- (void)ignoreRule:(enum AxeRuleId)rule onElementOfClass:(NSString * _Nonnull)className;
|
|
722
|
+
/// Ignores built-in rules, given by wire name, on every element whose accessibility identifier
|
|
723
|
+
/// is <code>id</code>. The element-scoped form of <code>ignoreRulesNamed:</code>, for the same Appium WebDriverAgent
|
|
724
|
+
/// integration, and hidden from Swift for the same reason. Names that match no built-in rule
|
|
725
|
+
/// are logged and skipped, and an empty list does nothing. Not affected by <code>allowUserOverrides</code>.
|
|
726
|
+
- (void)ignoreRulesNamed:(NSArray<NSString *> * _Nonnull)names onElementWithId:(NSString * _Nonnull)id;
|
|
727
|
+
/// Ignores built-in rules, given by wire name, on every element whose class name is exactly
|
|
728
|
+
/// <code>className</code>. The element-scoped form of <code>ignoreRulesNamed:</code>; see
|
|
729
|
+
/// <code>ignoreRulesNamed:onElementWithId:</code>.
|
|
730
|
+
- (void)ignoreRulesNamed:(NSArray<NSString *> * _Nonnull)names onElementOfClass:(NSString * _Nonnull)className;
|
|
846
731
|
@end
|
|
847
732
|
|
|
848
733
|
/// Information about the device used when the scan was created.
|
|
@@ -998,6 +883,8 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI14AxeIntegration")
|
|
|
998
883
|
@interface AxeIntegration : NSObject
|
|
999
884
|
/// Called once per process by the integrating product to identify itself. A second
|
|
1000
885
|
/// call declaring a different product is logged and ignored, not silently applied.
|
|
886
|
+
/// An <code>.appium3</code> declaration is skipped inside the Desktop Analyzer, which drives scans through
|
|
887
|
+
/// the same Appium 3 WebDriverAgent build; recorded first, it would outrank <code>detect()</code> for the whole process.
|
|
1001
888
|
+ (void)declareProduct:(enum AxeProductKind)product version:(NSString * _Nonnull)version;
|
|
1002
889
|
/// Called once per process by the integrating layer (the Appium driver, the Desktop
|
|
1003
890
|
/// Analyzer, MCP) to say who triggered this session and which product surface it came
|
|
@@ -1097,7 +984,6 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeResult")
|
|
|
1097
984
|
@interface AxeResult : NSObject
|
|
1098
985
|
@property (nonatomic, copy) NSString * _Nullable sessionId;
|
|
1099
986
|
@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
987
|
/// The configuration of the scan
|
|
1102
988
|
@property (nonatomic, readonly, strong) AxeConf * _Nonnull axeConf;
|
|
1103
989
|
/// Information about the screen that was scanned
|
|
@@ -1132,48 +1018,30 @@ typedef SWIFT_ENUM(NSInteger, AxeRole, open) {
|
|
|
1132
1018
|
AxeRoleGenericElement = 3,
|
|
1133
1019
|
};
|
|
1134
1020
|
|
|
1135
|
-
/// A unique name for each of the rules the SDK registers.
|
|
1136
|
-
///
|
|
1021
|
+
/// A unique name for each of the rules the SDK registers. All run by default; see
|
|
1022
|
+
/// <code>AxeDevTools.ignoreRules(_:)</code> to ignore rules.
|
|
1023
|
+
/// The case names are lowerCamelCase per the Swift API design guidelines. <code>toString()</code> deliberately
|
|
1024
|
+
/// keeps the historical UpperCamelCase strings: those are wire identity, matched by stored customer
|
|
1025
|
+
/// configuration, Developer Hub, and the Appium driver. See <code>AxeRuleIdWireIdentityTests</code>.
|
|
1137
1026
|
typedef SWIFT_ENUM(NSInteger, AxeRuleId, open) {
|
|
1138
|
-
/// Deprecated. Renamed to <code>a11yElementFocusBox</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1139
1027
|
AxeRuleIdA11yElementFocusBox = 0,
|
|
1140
|
-
/// Deprecated. Renamed to <code>activeControlName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1141
1028
|
AxeRuleIdActiveControlName = 1,
|
|
1142
|
-
/// Deprecated. Renamed to <code>associatedText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1143
1029
|
AxeRuleIdAssociatedText = 2,
|
|
1144
|
-
/// Deprecated. Renamed to <code>clippedText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1145
1030
|
AxeRuleIdClippedText = 3,
|
|
1146
|
-
/// Deprecated. Renamed to <code>collidingViews</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1147
1031
|
AxeRuleIdCollidingViews = 4,
|
|
1148
|
-
/// Deprecated. Renamed to <code>colorContrast</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1149
1032
|
AxeRuleIdColorContrast = 5,
|
|
1150
|
-
/// Deprecated. Renamed to <code>conflictingTraits</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1151
1033
|
AxeRuleIdConflictingTraits = 6,
|
|
1152
|
-
/// Deprecated. Renamed to <code>focusableText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1153
1034
|
AxeRuleIdFocusableText = 7,
|
|
1154
|
-
/// Deprecated. Renamed to <code>imageViewName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1155
1035
|
AxeRuleIdImageViewName = 8,
|
|
1156
|
-
/// Deprecated. Renamed to <code>inScrollView</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1157
1036
|
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
1037
|
AxeRuleIdLabelAtFront = 11,
|
|
1162
|
-
/// Deprecated. Renamed to <code>labelInName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1163
1038
|
AxeRuleIdLabelInName = 12,
|
|
1164
|
-
/// Deprecated. Renamed to <code>meaningfulAccessibleName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1165
1039
|
AxeRuleIdMeaningfulAccessibleName = 13,
|
|
1166
|
-
/// Deprecated. Renamed to <code>nestedElementsName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1167
1040
|
AxeRuleIdNestedElementsName = 14,
|
|
1168
|
-
/// Deprecated. Renamed to <code>screenOrientation</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1169
1041
|
AxeRuleIdScreenOrientation = 15,
|
|
1170
|
-
/// Deprecated. Renamed to <code>screenTitle</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1171
1042
|
AxeRuleIdScreenTitle = 16,
|
|
1172
|
-
/// Deprecated. Renamed to <code>supportsDynamicType</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1173
1043
|
AxeRuleIdSupportsDynamicType = 17,
|
|
1174
|
-
/// Deprecated. Renamed to <code>touchTargetSize</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1175
1044
|
AxeRuleIdTouchTargetSize = 18,
|
|
1176
|
-
/// Deprecated. Renamed to <code>touchTargetSpacing</code>; this spelling is removed in the October 2026 release (#3081).
|
|
1177
1045
|
AxeRuleIdTouchTargetSpacing = 19,
|
|
1178
1046
|
};
|
|
1179
1047
|
|
|
@@ -1198,12 +1066,6 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI13AxeRuleResult")
|
|
|
1198
1066
|
@property (nonatomic, readonly, copy) NSString * _Nonnull axeViewId;
|
|
1199
1067
|
/// whether the view is in the current screenshot. Will be false if the view is off-screen or behind a modal.
|
|
1200
1068
|
@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
1069
|
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1208
1070
|
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
1209
1071
|
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
@@ -1220,8 +1082,6 @@ typedef SWIFT_ENUM(NSInteger, AxeStatus, open) {
|
|
|
1220
1082
|
AxeStatusPASS = 2,
|
|
1221
1083
|
/// The view has an accessibility issue.
|
|
1222
1084
|
AxeStatusFAIL = 3,
|
|
1223
|
-
/// The view was not checked for accessibility issues.
|
|
1224
|
-
AxeStatusIGNORED = 4,
|
|
1225
1085
|
};
|
|
1226
1086
|
|
|
1227
1087
|
typedef SWIFT_ENUM(NSInteger, AxeSuccessCriteria, open) {
|
|
@@ -1506,12 +1366,6 @@ typedef SWIFT_ENUM(NSInteger, AxeViewHierarchy, open) {
|
|
|
1506
1366
|
/// 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
1367
|
SWIFT_CLASS("_TtC15axeDevToolsXCUI8RuleConf")
|
|
1508
1368
|
@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
1369
|
/// A brief description of the rule.
|
|
1516
1370
|
@property (nonatomic, readonly, copy) NSString * _Nonnull summary;
|
|
1517
1371
|
/// The severity of a failure of the rule. See <code>AxeImpact</code> for more information.
|
|
@@ -1921,7 +1775,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) AutoScanMana
|
|
|
1921
1775
|
+ (AutoScanManager * _Nonnull)shared SWIFT_WARN_UNUSED_RESULT;
|
|
1922
1776
|
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
1923
1777
|
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
1924
|
-
|
|
1778
|
+
/// Called from WDA: authenticates and configures AutoScanManager without reading from axe_config.json.
|
|
1779
|
+
///
|
|
1780
|
+
/// throws:
|
|
1781
|
+
/// An error if <code>axeAccountUrl</code> is not an https URL (pass an empty string for Deque’s
|
|
1782
|
+
/// server), if the API key or projectId is invalid, or if authentication fails.
|
|
1783
|
+
- (BOOL)enableWithBundleId:(NSString * _Nonnull)bundleId apiKey:(NSString * _Nonnull)apiKey axeAccountUrl:(NSString * _Nonnull)axeAccountUrl projectId:(NSString * _Nonnull)projectId uploadToDashboard:(BOOL)uploadToDashboard htmlReportPath:(NSString * _Nullable)htmlReportPath error:(NSError * _Nullable * _Nullable)error;
|
|
1925
1784
|
/// Captures the current screen state without requiring a gesture trigger.
|
|
1926
1785
|
/// Called from WDA after enable() to capture the initial screen.
|
|
1927
1786
|
- (void)captureInitialContext;
|
|
@@ -1984,44 +1843,17 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeBounds")
|
|
|
1984
1843
|
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1985
1844
|
@end
|
|
1986
1845
|
|
|
1987
|
-
/// The configuration
|
|
1988
|
-
/// By default, all <code>AxeRule</code>s
|
|
1846
|
+
/// The rule configuration a scan ran with, exposed on <code>AxeResult.axeConf</code>.
|
|
1847
|
+
/// By default, all <code>AxeRule</code>s run. To ignore rules or add custom rules, use
|
|
1848
|
+
/// <code>AxeDevTools.ignoreRules(_:)</code> and <code>AxeDevTools.addCustomRule(_:)</code>.
|
|
1989
1849
|
SWIFT_CLASS("_TtC15axeDevToolsXCUI7AxeConf")
|
|
1990
1850
|
@interface AxeConf : NSObject
|
|
1991
1851
|
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
1992
1852
|
/// 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
1853
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
1994
|
-
|
|
1995
|
-
|
|
1996
|
-
|
|
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.");
|
|
1854
|
+
- (void)ignoreWithRule:(NSString * _Nonnull)rule :(BOOL)shouldIgnore SWIFT_UNAVAILABLE_MSG("'ignore' has been renamed to 'AxeDevTools.ignoreRules(_:)': Ignore built-in rules with typed values, e.g. axe.ignoreRules(.colorContrast). Ignoring a custom rule and switching a rule back on were removed. See the October 2026 migration note.");
|
|
1855
|
+
- (void)ignoreWithRules:(NSArray<NSString *> * _Nonnull)rules :(BOOL)shouldIgnore SWIFT_UNAVAILABLE_MSG("'ignore' has been renamed to 'AxeDevTools.ignoreRules(_:)': Ignore built-in rules with typed values, e.g. axe.ignoreRules(.colorContrast, .screenTitle). Ignoring a custom rule and switching a rule back on were removed. See the October 2026 migration note.");
|
|
1856
|
+
- (void)ignoreWithRulesFor:(NSDictionary<NSString *, NSSet<NSString *> *> * _Nonnull)rulesFor SWIFT_UNAVAILABLE_MSG("'ignore' has been renamed to 'AxeDevTools.ignoreRules(onElementWithId:_:)': Use axe.ignoreRules(onElementWithId:_:) for an accessibility identifier or axe.ignoreRules(onElementOfClass:_:) for a class name. See the October 2026 migration note.");
|
|
2025
1857
|
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2026
1858
|
@end
|
|
2027
1859
|
|
|
@@ -2045,7 +1877,6 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI10AxeContext")
|
|
|
2045
1877
|
+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
|
|
2046
1878
|
@end
|
|
2047
1879
|
|
|
2048
|
-
@class AxeDevToolsResultKey;
|
|
2049
1880
|
@class AxeResult;
|
|
2050
1881
|
/// AxeDevTools class contains many static methods for you to set up testing for accessibility.
|
|
2051
1882
|
/// With this class, you can:
|
|
@@ -2062,68 +1893,21 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI10AxeContext")
|
|
|
2062
1893
|
/// </ul>
|
|
2063
1894
|
SWIFT_CLASS("_TtC15axeDevToolsXCUI11AxeDevTools")
|
|
2064
1895
|
@interface AxeDevTools : NSObject
|
|
2065
|
-
///
|
|
2066
|
-
///
|
|
2067
|
-
|
|
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.");
|
|
1896
|
+
/// Removed in the October 2026 release. Rules are ignored and custom rules registered on
|
|
1897
|
+
/// <code>AxeDevTools</code> itself.
|
|
1898
|
+
@property (nonatomic, readonly, strong) AxeConf * _Nonnull configuration SWIFT_UNAVAILABLE_MSG("Use axe.ignoreRules(...) to ignore rules and axe.addCustomRule(_:) to register a custom rule. See the October 2026 migration note.");
|
|
2070
1899
|
/// Set this property to <code>true</code> if you want additional debug information for unexpected behavior.
|
|
2071
1900
|
/// We may request this to be turned on if an obscure bug is found.
|
|
2072
1901
|
SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
2073
1902
|
+ (BOOL)debugStatements SWIFT_WARN_UNUSED_RESULT;
|
|
2074
1903
|
+ (void)setDebugStatements:(BOOL)value;
|
|
2075
1904
|
@property (nonatomic, readonly, copy) NSString * _Nullable sessionId;
|
|
2076
|
-
///
|
|
2077
|
-
/// \param
|
|
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.
|
|
1905
|
+
/// Use this after calling <code>run</code> to send the scan to the Developer Hub. Will throw an error if sending the scan was not successful.
|
|
1906
|
+
/// \param result The result that should be pushed to the Developer Hub.
|
|
2098
1907
|
///
|
|
2099
|
-
/// \param
|
|
1908
|
+
/// \param scanName A String to change the scan name to in the Developer Hub.
|
|
2100
1909
|
///
|
|
2101
|
-
|
|
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.");
|
|
1910
|
+
- (BOOL)postResult:(AxeResult * _Nonnull)result withScanName:(NSString * _Nullable)scanName error:(NSError * _Nullable * _Nullable)error;
|
|
2127
1911
|
/// Utilize this API with your result from calling <code>run</code> and save your accessibility results locally to your machine as JSON.
|
|
2128
1912
|
/// \param result The AxeResult object returned from the <code>run</code> API.
|
|
2129
1913
|
///
|
|
@@ -2193,72 +1977,17 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
2193
1977
|
- (AxeReportResult * _Nullable)generateHtmlReportAndSummaryWithOutputPath:(NSString * _Nullable)outputPath error:(NSError * _Nullable * _Nullable)error;
|
|
2194
1978
|
@end
|
|
2195
1979
|
|
|
1980
|
+
@class NSURL;
|
|
1981
|
+
@interface AxeDevTools (SWIFT_EXTENSION(axeDevToolsXCUI))
|
|
1982
|
+
/// A link to this project’s page in Axe Developer Hub, which lists the project’s recent runs.
|
|
1983
|
+
/// The SDK logs it after each successful targeted upload; an AutoScan run logs a link to its
|
|
1984
|
+
/// own session instead. Nil when the session does not upload results, for example one
|
|
1985
|
+
/// started with <code>authenticate</code>, <code>loginWithAccessToken</code>, or <code>startScanSession</code> with
|
|
1986
|
+
/// <code>axeUploadResults: false</code>.
|
|
1987
|
+
@property (nonatomic, readonly, copy) NSURL * _Nullable devHubResultsURL;
|
|
1988
|
+
@end
|
|
1989
|
+
|
|
2196
1990
|
@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
1991
|
/// Starts a session with the axeDevTools cloud instance using an API key and project ID.
|
|
2263
1992
|
/// This is the recommended method to initialize axeDevTools for accessibility testing. A valid session is required before utilizing the framework’s features.
|
|
2264
1993
|
/// <ul>
|
|
@@ -2266,12 +1995,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
2266
1995
|
/// For Objective-C, pass in an empty String to the <code>axeAccountUrl</code> parameter and the default server will be used.
|
|
2267
1996
|
/// </li>
|
|
2268
1997
|
/// <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.
|
|
1998
|
+
/// Will throw an error if <code>axeAccountUrl</code> is not an https URL, if the API key or projectId is not valid, or if <code>axeUploadResults</code> is true and no <code>projectId</code> was supplied.
|
|
2270
1999
|
/// </li>
|
|
2271
2000
|
/// </ul>
|
|
2272
2001
|
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
2273
2002
|
///
|
|
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).
|
|
2003
|
+
/// \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, and must be an https URL. Defaults to empty string (uses default server).
|
|
2275
2004
|
///
|
|
2276
2005
|
/// \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
2006
|
///
|
|
@@ -2279,7 +2008,7 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
2279
2008
|
///
|
|
2280
2009
|
///
|
|
2281
2010
|
/// 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.
|
|
2011
|
+
/// An error if either <code>axeUploadResults</code> is true and <code>projectId</code> is absent or empty, if <code>axeAccountUrl</code> is not an https URL, or if the API key or projectId is invalid or authentication fails.
|
|
2283
2012
|
///
|
|
2284
2013
|
/// returns:
|
|
2285
2014
|
/// An instantiated AxeDevTools object ready for accessibility testing.
|
|
@@ -2291,12 +2020,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
2291
2020
|
/// For Objective-C, pass in an empty String to the <code>axeAccountUrl</code> parameter and the default server will be used.
|
|
2292
2021
|
/// </li>
|
|
2293
2022
|
/// <li>
|
|
2294
|
-
/// The completion handler is called with an error if the API key is not valid.
|
|
2023
|
+
/// The completion handler is called with an error if <code>axeAccountUrl</code> is not an https URL or the API key is not valid.
|
|
2295
2024
|
/// </li>
|
|
2296
2025
|
/// </ul>
|
|
2297
2026
|
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
2298
2027
|
///
|
|
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).
|
|
2028
|
+
/// \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, and must be an https URL. Defaults to empty string (uses default server).
|
|
2300
2029
|
///
|
|
2301
2030
|
/// \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
2031
|
///
|
|
@@ -2311,13 +2040,13 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
2311
2040
|
/// with <code>axeUploadResults</code> set to <code>NO</code>.
|
|
2312
2041
|
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
2313
2042
|
///
|
|
2314
|
-
/// \param axeAccountUrl URL of the server receiving the scans. Pass an empty string for Deque’s.
|
|
2043
|
+
/// \param axeAccountUrl URL of the server receiving the scans; must be an https URL. Pass an empty string for Deque’s.
|
|
2315
2044
|
///
|
|
2316
2045
|
/// \param projectId The project ID for uploading results to Axe Developer Hub.
|
|
2317
2046
|
///
|
|
2318
2047
|
///
|
|
2319
2048
|
/// throws:
|
|
2320
|
-
/// An error if the API key or projectId is invalid, or authentication fails.
|
|
2049
|
+
/// An error if <code>axeAccountUrl</code> is not an https URL, if the API key or projectId is invalid, or if authentication fails.
|
|
2321
2050
|
///
|
|
2322
2051
|
/// returns:
|
|
2323
2052
|
/// An instantiated AxeDevTools object ready for accessibility testing.
|
|
@@ -2328,15 +2057,16 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
2328
2057
|
/// Authenticates with a pre-obtained OAuth access token.
|
|
2329
2058
|
/// Use this when your integration already holds a valid Bearer token
|
|
2330
2059
|
/// (e.g., from an MCP server) and you want to run local scans without
|
|
2331
|
-
/// uploading results to the Deque backend.
|
|
2060
|
+
/// uploading results to the Deque backend. The account needs an axe DevTools Mobile
|
|
2061
|
+
/// subscription, and the company’s rule configuration is applied.
|
|
2332
2062
|
/// \param accessToken A valid OAuth access token (Bearer token).
|
|
2333
2063
|
///
|
|
2334
2064
|
/// \param axeAccountUrl URL of the axe account instance. Only needed for
|
|
2335
|
-
/// enterprises with their own instance. Defaults to empty string (uses default server).
|
|
2065
|
+
/// enterprises with their own instance, and must be an https URL. Defaults to empty string (uses default server).
|
|
2336
2066
|
///
|
|
2337
2067
|
///
|
|
2338
2068
|
/// throws:
|
|
2339
|
-
/// An error if the access token is invalid or authentication fails.
|
|
2069
|
+
/// An error if <code>axeAccountUrl</code> is not an https URL, if the access token is invalid, if the account has no axe DevTools Mobile subscription, or if authentication fails.
|
|
2340
2070
|
///
|
|
2341
2071
|
/// returns:
|
|
2342
2072
|
/// An initialized AxeDevTools object ready for local scanning.
|
|
@@ -2350,41 +2080,50 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL debugStatements;)
|
|
|
2350
2080
|
/// </ul>
|
|
2351
2081
|
/// \param apiKey API Key for axeDevTools provided by Deque Systems.
|
|
2352
2082
|
///
|
|
2353
|
-
/// \param axeAccountUrl URL of the axe account instance. Only needed for enterprises with their own instance. Defaults to empty string (uses default server).
|
|
2083
|
+
/// \param axeAccountUrl URL of the axe account instance. Only needed for enterprises with their own instance, and must be an https URL. Defaults to empty string (uses default server).
|
|
2354
2084
|
///
|
|
2355
2085
|
///
|
|
2356
2086
|
/// throws:
|
|
2357
|
-
/// An error if the API key is invalid or authentication fails.
|
|
2087
|
+
/// An error if <code>axeAccountUrl</code> is not an https URL, if the API key is invalid, or if authentication fails.
|
|
2358
2088
|
///
|
|
2359
2089
|
/// returns:
|
|
2360
2090
|
/// An initialized AxeDevTools object ready for local scanning.
|
|
2361
2091
|
+ (AxeDevTools * _Nullable)authenticateWithApiKey:(NSString * _Nonnull)apiKey axeAccountUrl:(NSString * _Nonnull)axeAccountUrl error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
|
|
2362
2092
|
@end
|
|
2363
2093
|
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
///
|
|
2369
|
-
|
|
2370
|
-
///
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
///
|
|
2375
|
-
///
|
|
2376
|
-
///
|
|
2377
|
-
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
///
|
|
2381
|
-
///
|
|
2382
|
-
///
|
|
2383
|
-
///
|
|
2384
|
-
- (
|
|
2385
|
-
-
|
|
2386
|
-
- (
|
|
2387
|
-
|
|
2094
|
+
SWIFT_ENUM_FWD_DECL(NSInteger, AxeRuleId)
|
|
2095
|
+
@interface AxeDevTools (SWIFT_EXTENSION(axeDevToolsXCUI))
|
|
2096
|
+
/// Ignores one built-in rule for every scan from this instance. Objective-C cannot pass a list of
|
|
2097
|
+
/// <code>AxeRuleId</code> values, so Objective-C callers ignore rules one call at a time:
|
|
2098
|
+
/// \code
|
|
2099
|
+
/// [axe ignoreRule:AxeRuleIdColorContrast];
|
|
2100
|
+
///
|
|
2101
|
+
/// \endcodeSwift callers use <code>ignoreRules(_:)</code>.
|
|
2102
|
+
- (void)ignoreRule:(enum AxeRuleId)rule;
|
|
2103
|
+
/// Ignores built-in rules by their wire name (<code>AxeRuleId.toString()</code>, e.g. <code>"ColorContrast"</code>).
|
|
2104
|
+
/// Exists for the Appium WebDriverAgent integration, which receives rule names as text from the
|
|
2105
|
+
/// Appium driver; hidden from Swift so no Swift caller can pass a misspelled name. Names that
|
|
2106
|
+
/// match no built-in rule are logged and skipped, and an empty list does nothing.
|
|
2107
|
+
- (void)ignoreRulesNamed:(NSArray<NSString *> * _Nonnull)names;
|
|
2108
|
+
/// Ignores one built-in rule on every element whose accessibility identifier is <code>id</code>. The
|
|
2109
|
+
/// Objective-C form of <code>ignoreRules(onElementWithId:_:)</code>, called once per rule:
|
|
2110
|
+
/// \code
|
|
2111
|
+
/// [axe ignoreRule:AxeRuleIdColorContrast onElementWithId:@"loginButton"];
|
|
2112
|
+
///
|
|
2113
|
+
/// \endcode
|
|
2114
|
+
- (void)ignoreRule:(enum AxeRuleId)rule onElementWithId:(NSString * _Nonnull)id;
|
|
2115
|
+
/// Ignores one built-in rule on every element whose class name is exactly <code>className</code>. The
|
|
2116
|
+
/// Objective-C form of <code>ignoreRules(onElementOfClass:_:)</code>, called once per rule.
|
|
2117
|
+
- (void)ignoreRule:(enum AxeRuleId)rule onElementOfClass:(NSString * _Nonnull)className;
|
|
2118
|
+
/// Ignores built-in rules, given by wire name, on every element whose accessibility identifier
|
|
2119
|
+
/// is <code>id</code>. The element-scoped form of <code>ignoreRulesNamed:</code>, for the same Appium WebDriverAgent
|
|
2120
|
+
/// integration, and hidden from Swift for the same reason. Names that match no built-in rule
|
|
2121
|
+
/// are logged and skipped, and an empty list does nothing. Not affected by <code>allowUserOverrides</code>.
|
|
2122
|
+
- (void)ignoreRulesNamed:(NSArray<NSString *> * _Nonnull)names onElementWithId:(NSString * _Nonnull)id;
|
|
2123
|
+
/// Ignores built-in rules, given by wire name, on every element whose class name is exactly
|
|
2124
|
+
/// <code>className</code>. The element-scoped form of <code>ignoreRulesNamed:</code>; see
|
|
2125
|
+
/// <code>ignoreRulesNamed:onElementWithId:</code>.
|
|
2126
|
+
- (void)ignoreRulesNamed:(NSArray<NSString *> * _Nonnull)names onElementOfClass:(NSString * _Nonnull)className;
|
|
2388
2127
|
@end
|
|
2389
2128
|
|
|
2390
2129
|
/// Information about the device used when the scan was created.
|
|
@@ -2540,6 +2279,8 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI14AxeIntegration")
|
|
|
2540
2279
|
@interface AxeIntegration : NSObject
|
|
2541
2280
|
/// Called once per process by the integrating product to identify itself. A second
|
|
2542
2281
|
/// call declaring a different product is logged and ignored, not silently applied.
|
|
2282
|
+
/// An <code>.appium3</code> declaration is skipped inside the Desktop Analyzer, which drives scans through
|
|
2283
|
+
/// the same Appium 3 WebDriverAgent build; recorded first, it would outrank <code>detect()</code> for the whole process.
|
|
2543
2284
|
+ (void)declareProduct:(enum AxeProductKind)product version:(NSString * _Nonnull)version;
|
|
2544
2285
|
/// Called once per process by the integrating layer (the Appium driver, the Desktop
|
|
2545
2286
|
/// Analyzer, MCP) to say who triggered this session and which product surface it came
|
|
@@ -2639,7 +2380,6 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI9AxeResult")
|
|
|
2639
2380
|
@interface AxeResult : NSObject
|
|
2640
2381
|
@property (nonatomic, copy) NSString * _Nullable sessionId;
|
|
2641
2382
|
@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
2383
|
/// The configuration of the scan
|
|
2644
2384
|
@property (nonatomic, readonly, strong) AxeConf * _Nonnull axeConf;
|
|
2645
2385
|
/// Information about the screen that was scanned
|
|
@@ -2674,48 +2414,30 @@ typedef SWIFT_ENUM(NSInteger, AxeRole, open) {
|
|
|
2674
2414
|
AxeRoleGenericElement = 3,
|
|
2675
2415
|
};
|
|
2676
2416
|
|
|
2677
|
-
/// A unique name for each of the rules the SDK registers.
|
|
2678
|
-
///
|
|
2417
|
+
/// A unique name for each of the rules the SDK registers. All run by default; see
|
|
2418
|
+
/// <code>AxeDevTools.ignoreRules(_:)</code> to ignore rules.
|
|
2419
|
+
/// The case names are lowerCamelCase per the Swift API design guidelines. <code>toString()</code> deliberately
|
|
2420
|
+
/// keeps the historical UpperCamelCase strings: those are wire identity, matched by stored customer
|
|
2421
|
+
/// configuration, Developer Hub, and the Appium driver. See <code>AxeRuleIdWireIdentityTests</code>.
|
|
2679
2422
|
typedef SWIFT_ENUM(NSInteger, AxeRuleId, open) {
|
|
2680
|
-
/// Deprecated. Renamed to <code>a11yElementFocusBox</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2681
2423
|
AxeRuleIdA11yElementFocusBox = 0,
|
|
2682
|
-
/// Deprecated. Renamed to <code>activeControlName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2683
2424
|
AxeRuleIdActiveControlName = 1,
|
|
2684
|
-
/// Deprecated. Renamed to <code>associatedText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2685
2425
|
AxeRuleIdAssociatedText = 2,
|
|
2686
|
-
/// Deprecated. Renamed to <code>clippedText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2687
2426
|
AxeRuleIdClippedText = 3,
|
|
2688
|
-
/// Deprecated. Renamed to <code>collidingViews</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2689
2427
|
AxeRuleIdCollidingViews = 4,
|
|
2690
|
-
/// Deprecated. Renamed to <code>colorContrast</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2691
2428
|
AxeRuleIdColorContrast = 5,
|
|
2692
|
-
/// Deprecated. Renamed to <code>conflictingTraits</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2693
2429
|
AxeRuleIdConflictingTraits = 6,
|
|
2694
|
-
/// Deprecated. Renamed to <code>focusableText</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2695
2430
|
AxeRuleIdFocusableText = 7,
|
|
2696
|
-
/// Deprecated. Renamed to <code>imageViewName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2697
2431
|
AxeRuleIdImageViewName = 8,
|
|
2698
|
-
/// Deprecated. Renamed to <code>inScrollView</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2699
2432
|
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
2433
|
AxeRuleIdLabelAtFront = 11,
|
|
2704
|
-
/// Deprecated. Renamed to <code>labelInName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2705
2434
|
AxeRuleIdLabelInName = 12,
|
|
2706
|
-
/// Deprecated. Renamed to <code>meaningfulAccessibleName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2707
2435
|
AxeRuleIdMeaningfulAccessibleName = 13,
|
|
2708
|
-
/// Deprecated. Renamed to <code>nestedElementsName</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2709
2436
|
AxeRuleIdNestedElementsName = 14,
|
|
2710
|
-
/// Deprecated. Renamed to <code>screenOrientation</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2711
2437
|
AxeRuleIdScreenOrientation = 15,
|
|
2712
|
-
/// Deprecated. Renamed to <code>screenTitle</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2713
2438
|
AxeRuleIdScreenTitle = 16,
|
|
2714
|
-
/// Deprecated. Renamed to <code>supportsDynamicType</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2715
2439
|
AxeRuleIdSupportsDynamicType = 17,
|
|
2716
|
-
/// Deprecated. Renamed to <code>touchTargetSize</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2717
2440
|
AxeRuleIdTouchTargetSize = 18,
|
|
2718
|
-
/// Deprecated. Renamed to <code>touchTargetSpacing</code>; this spelling is removed in the October 2026 release (#3081).
|
|
2719
2441
|
AxeRuleIdTouchTargetSpacing = 19,
|
|
2720
2442
|
};
|
|
2721
2443
|
|
|
@@ -2740,12 +2462,6 @@ SWIFT_CLASS("_TtC15axeDevToolsXCUI13AxeRuleResult")
|
|
|
2740
2462
|
@property (nonatomic, readonly, copy) NSString * _Nonnull axeViewId;
|
|
2741
2463
|
/// whether the view is in the current screenshot. Will be false if the view is off-screen or behind a modal.
|
|
2742
2464
|
@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
2465
|
@property (nonatomic, readonly, copy) NSString * _Nonnull description;
|
|
2750
2466
|
- (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;
|
|
2751
2467
|
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
|
|
@@ -2762,8 +2478,6 @@ typedef SWIFT_ENUM(NSInteger, AxeStatus, open) {
|
|
|
2762
2478
|
AxeStatusPASS = 2,
|
|
2763
2479
|
/// The view has an accessibility issue.
|
|
2764
2480
|
AxeStatusFAIL = 3,
|
|
2765
|
-
/// The view was not checked for accessibility issues.
|
|
2766
|
-
AxeStatusIGNORED = 4,
|
|
2767
2481
|
};
|
|
2768
2482
|
|
|
2769
2483
|
typedef SWIFT_ENUM(NSInteger, AxeSuccessCriteria, open) {
|
|
@@ -3048,12 +2762,6 @@ typedef SWIFT_ENUM(NSInteger, AxeViewHierarchy, open) {
|
|
|
3048
2762
|
/// 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
2763
|
SWIFT_CLASS("_TtC15axeDevToolsXCUI8RuleConf")
|
|
3050
2764
|
@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
2765
|
/// A brief description of the rule.
|
|
3058
2766
|
@property (nonatomic, readonly, copy) NSString * _Nonnull summary;
|
|
3059
2767
|
/// The severity of a failure of the rule. See <code>AxeImpact</code> for more information.
|