XCUIElement Class Reference
| Inherits from | NSObject |
|---|---|
| Conforms to | XCUIElementAttributes XCUIElementTypeQueryProvider |
| Declared in | XCUIElement.h |
Overview
@class XCUIElement (/seealso XCUIElementAttributes) Elements are objects encapsulating the information needed to dynamically locate a user interface element in an application. Elements are described in terms of queries /seealso XCUIElementQuery.
This category on XCUIElement provides functionality for automating UISlider and NSSlider. This category on XCUIElement provides functionality for automating the picker wheels of UIPickerViews and UIDatePickers.
@category Events Events that can be synthesized relative to an XCUIElement object. When an event API is called, the element will be resolved. If zero or multiple matches are found, an error will be raised.
Other Methods
exists
Test to determine if the element exists.
@property (readonly) BOOL existsDeclared In
XCUIElement.h
hittable
Whether or not a hit point can be computed for the element for the purpose of synthesizing events.
@property (readonly, getter=isHittable) BOOL hittableDeclared In
XCUIElement.h
– descendantsMatchingType:
Returns a query for all descendants of the element matching the specified type.
- (XCUIElementQuery *)descendantsMatchingType:(XCUIElementType)typeDeclared In
XCUIElement.h
– childrenMatchingType:
Returns a query for direct children of the element matching the specified type.
- (XCUIElementQuery *)childrenMatchingType:(XCUIElementType)typeDeclared In
XCUIElement.h
– coordinateWithNormalizedOffset:
Creates and returns a new coordinate that will compute its screen point by adding the offset multiplied by the size of the element’s frame to the origin of the element’s frame.
- (XCUICoordinate *)coordinateWithNormalizedOffset:(CGVector)normalizedOffsetDeclared In
XCUIElement.h
debugDescription
@discussion Provides debugging information about the element. The data in the string will vary based on the time at which it is captured, but it may include any of the following as well as additional data: • Values for the elements attributes. • The entire tree of descendants rooted at the element. • The element’s query. This data should be used for debugging only - depending on any of the data as part of a test is unsupported.
@property (readonly, copy) NSString *debugDescriptionDeclared In
XCUIElement.h
XCUIElementTypeSlider Methods
– adjustToNormalizedSliderPosition:
Manipulates the UI to change the displayed value of the slider to one based on a normalized position. 0 corresponds to the minimum value of the slider, 1 corresponds to its maximum value. The adjustment is a “best effort” to move the indicator to the desired position; absolute fidelity is not guaranteed.
- (void)adjustToNormalizedSliderPosition:(CGFloat)normalizedSliderPositionDeclared In
XCUIElement.h
normalizedSliderPosition
Returns the position of the slider’s indicator as a normalized value where 0 corresponds to the minimum value of the slider and 1 corresponds to its maximum value.
@property (readonly) CGFloat normalizedSliderPositionDeclared In
XCUIElement.h
XCUIElementTypePickerWheel Methods
– adjustToPickerWheelValue:
Changes the displayed value for the picker wheel. Will generate a test failure if the specified value is not available.
- (void)adjustToPickerWheelValue:(NSString *)pickerWheelValueDeclared In
XCUIElement.h
XCUIElementEventSynthesis Methods
– typeText:
Types a string into the element. The element or a descendant must have keyboard focus; otherwise an error is raised.
- (void)typeText:(NSString *)textDiscussion
This API discards any modifiers set in the current context by performWithKeyModifiers:block: so that it strictly interprets the provided text. To input keys with modifier flags, use typeKey:modifierFlags:.
Declared In
XCUIElement.h
– tap
Sends a tap event to a hittable point computed for the element.
- (void)tapDeclared In
XCUIElement.h
– tapWithNumberOfTaps:numberOfTouches:
Sends one or more taps with one of more touch points.
- (void)tapWithNumberOfTaps:(NSUInteger)numberOfTaps numberOfTouches:(NSUInteger)numberOfTouchesDiscussion
@param numberOfTaps The number of taps.
@param numberOfTouches The number of touch points.
Declared In
XCUIElement.h
– pressForDuration:
Sends a long press gesture to a hittable point computed for the element, holding for the specified duration.
- (void)pressForDuration:(NSTimeInterval)durationDiscussion
@param duration Duration in seconds.
Declared In
XCUIElement.h
– pressForDuration:thenDragToElement:
Initiates a press-and-hold gesture that then drags to another element, suitable for table cell reordering and similar operations. @param duration Duration of the initial press-and-hold. @param otherElement The element to finish the drag gesture over. In the example of table cell reordering, this would be the reorder element of the destination row.
- (void)pressForDuration:(NSTimeInterval)duration thenDragToElement:(XCUIElement *)otherElementDeclared In
XCUIElement.h
– pinchWithScale:velocity:
Sends a pinching gesture with two touches.
- (void)pinchWithScale:(CGFloat)scale velocity:(CGFloat)velocityDiscussion
The system makes a best effort to synthesize the requested scale and velocity: absolute accuracy is not guaranteed. Some values may not be possible based on the size of the element’s frame - these will result in test failures.
@param scale The scale of the pinch gesture. Use a scale between 0 and 1 to “pinch close” or zoom out and a scale greater than 1 to “pinch open” or zoom in.
@param velocity The velocity of the pinch in scale factor per second.
Declared In
XCUIElement.h
– rotate:withVelocity:
Sends a rotation gesture with two touches.
- (void)rotate:(CGFloat)rotation withVelocity:(CGFloat)velocityDiscussion
The system makes a best effort to synthesize the requested rotation and velocity: absolute accuracy is not guaranteed. Some values may not be possible based on the size of the element’s frame - these will result in test failures.
@param rotation The rotation of the gesture in radians.
@param velocity The velocity of the rotation gesture in radians per second.
Declared In
XCUIElement.h
– click
Sends a click event to a hittable point computed for the element.
- (void)clickDeclared In
XCUIElement.h
– clickForDuration:thenDragToElement:
Clicks and holds for a specified duration (generally long enough to start a drag operation) then drags to the other element.
- (void)clickForDuration:(NSTimeInterval)duration thenDragToElement:(XCUIElement *)otherElementDeclared In
XCUIElement.h
+ performWithKeyModifiers:block:
Hold modifier keys while the given block runs. This method pushes and pops the modifiers as global state without need for reference to a particular element. Inside the block, elements can be clicked on, dragged from, typed into, etc.
+ (void)performWithKeyModifiers:(XCUIKeyModifierFlags)flags block:(void ( ^ ) ( void ))blockDeclared In
XCUIElement.h
– typeKey:modifierFlags:
Types a single key with the specified modifier flags. Although key is a string, it must represent
a single key on a physical keyboard; strings that resolve to multiple keys will raise an error at runtime.
In addition to literal string key representations like “a”, “6”, and “[”, keys such as the arrow keys,
command, control, option, and function keys can be typed using constants defined for them in XCUIKeyboardKeys.h
- (void)typeKey:(NSString *)key modifierFlags:(XCUIKeyModifierFlags)flagsDeclared In
XCUIElement.h
– scrollByDeltaX:deltaY:
Scroll the view the specified pixels, x and y.
- (void)scrollByDeltaX:(CGFloat)deltaX deltaY:(CGFloat)deltaYDeclared In
XCUIElement.h