1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.platform.helpers;
18 
19 /** Interface Helper class for generalized UI element manipulation */
20 public interface IAutoGeneralUIHelper extends IAppHelper {
21 
22     /**
23      * Setup expectation: none.
24      *
25      * <p>A general search-and-click method that attempts to click on a UIElement that has a
26      * particular text field.
27      *
28      * <p>This method is a "safe" call, meaning it will catch any exceptions from the attempt.
29      *
30      * @param text The text of the element to be clicked.
31      */
clickElementWithText(String text)32     void clickElementWithText(String text);
33 
34     /**
35      * Setup expectation: none.
36      *
37      * <p>Returns whether an element with the given text exists.
38      *
39      * <p>This method is a "safe" call, meaning it will catch any exceptions from the attempt.
40      *
41      * @param text The text of the element to be found.
42      * @return - Whether a UI Element with the given text exists.
43      */
hasElementWithText(String text)44     boolean hasElementWithText(String text);
45 }
46