io.appium.java_client.FindsByAccessibilityId Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

Java client for Appium Mobile Webdriver

There is a newer version: 9.3.0

/*
 * 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.
 */

package io.appium.java_client;

import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.WebElement;

import java.util.List;

public interface FindsByAccessibilityId extends FindsByFluentSelector {
    /**
     * Method performs the searching for a single element by accessibility ID selector
     * and value of the given selector.
     *
     * @param using an accessibility ID selector
     * @return The first element that matches the given selector
     *
     * @throws WebDriverException This method is not applicable with browser/webview UI.
     * @throws NoSuchElementException when no one element is found
     */
    default T findElementByAccessibilityId(String using) {
        return findElement(MobileSelector.ACCESSIBILITY.toString(), using);
    }

    /**
     * Method performs the searching for a list of elements by accessibility ID selector
     * and value of the given selector.
     *
     * @param using an accessibility ID selector
     * @return a list of elements that match the given selector
     *
     * @throws WebDriverException This method is not applicable with browser/webview UI.
     */
    default List findElementsByAccessibilityId(String using) {
        return findElements(MobileSelector.ACCESSIBILITY.toString(), using);
    }
}