/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <XCTest/XCTest.h>

NS_ASSUME_NONNULL_BEGIN

@interface XCUIElementQuery (AMHelpers)

/**
 Retrieves the first match from the query

 @returns Matched element instance or nil if no element is found
 */
- (nullable XCUIElement *)am_firstMatch;

/**
 Retrieves all matches from the query

 @returns Matched element instances or an empty array if no matches are found
 */
- (NSArray<XCUIElement *> *)am_allMatches;

/**
 Returns single unique matching snapshot for the given query

 @param error The error instance if there was a failure while retrieveing the snapshot
 @returns The unqiue snapshot or nil if the element is stale
 */
- (nullable id<XCUIElementSnapshot>)am_uniqueSnapshotWithError:(NSError **)error;

@end

NS_ASSUME_NONNULL_END