appium-webdriveragent/WebDriverAgentLib/Utilities/FBActiveAppDetectionPoint.h

/**
 * Copyright (c) 2015-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 */

#import <XCTest/XCTest.h>
@protocol FBXCAccessibilityElement;

NS_ASSUME_NONNULL_BEGIN

@interface FBActiveAppDetectionPoint : NSObject

@property (nonatomic) CGPoint coordinates;

/**
 * Retrieves singleton representation of the current class
 */
+ (instancetype)sharedInstance;

/**
 * Calculates the accessbility element which is located at the given screen coordinates
 *
 * @param point The screen coordinates
 * @returns The retrieved accessbility element or nil if it cannot be detected
 */
+ (nullable id<FBXCAccessibilityElement>)axElementWithPoint:(CGPoint)point;

/**
 * Retrieves the accessbility element for the current screen point
 *
 * @returns The retrieved accessbility element or nil if it cannot be detected
 */
- (nullable id<FBXCAccessibilityElement>)axElement;

/**
 * Sets the coordinates for the current screen point
 *
 * @param coordinatesStr The coordinates string in `x,y` format. x and y can be any float numbers
 * @param error Is assigned to the actual error object if coordinates cannot be set
 * @returns YES if the coordinates were successfully set
 */
- (BOOL)setCoordinatesWithString:(NSString *)coordinatesStr error:(NSError **)error;

/**
 * Retrieves the coordinates of the current screen point in string representation
 *
 * @returns Point coordinates as `x,y` string
 */
- (NSString *)stringCoordinates;

@end

NS_ASSUME_NONNULL_END