UNPKG

appium

Version:
102 lines (67 loc) 3.26 kB
# Is Element Displayed Determine if an element is currently displayed ## Example Usage ```java // Java MobileElement element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); boolean isDisplayed = element.isDisplayed(); ``` ```python # Python self.driver.find_element_by_accessibility_id('SomeAccessibilityID').is_displayed() ``` ```javascript // Javascript // webdriver.io example let isDisplayed = driver.elementIdDisplayed("~SomeAccessibilityId"); // wd example let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let isDisplayed = await element.isDisplayed(); ``` ```ruby # Ruby @driver.find_element(:accessibility_id, "SomeAccessibilityID").displayed? ``` ```php # PHP $el = $this->byAccessibilityId('SomeAccessibilityID'); $isDisplayed = $el->displayed(); ``` ```csharp // C# // TODO C# sample ``` ## Support ### Appium Server |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| | iOS | [XCUITest](/docs/en/drivers/ios-xcuitest.md) | 9.3+ | 1.6.0+ | All | | | [UIAutomation](/docs/en/drivers/ios-uiautomation.md) | 8.0 to 9.3 | All | All | | Android | [UiAutomator2](/docs/en/drivers/android-uiautomator2.md) | ?+ | 1.6.0+ | All | | | [UiAutomator](/docs/en/drivers/android-uiautomator.md) | 4.2+ | All | All | | Mac | [Mac](/docs/en/drivers/mac.md) | ?+ | 1.6.4+ | All | | Windows | [Windows](/docs/en/drivers/windows.md) | 10+ | 1.6.0+ | All | ### Appium Clients |Language|Support|Documentation| |--------|-------|-------------| |[Java](https://github.com/appium/java-client/releases/latest)| All | [seleniumhq.github.io](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/WebElement.html#isDisplayed--) | |[Python](https://github.com/appium/python-client/releases/latest)| All | [selenium-python.readthedocs.io](http://selenium-python.readthedocs.io/api.html#selenium.webdriver.remote.webelement.WebElement.is_displayed) | |[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All | [webdriver.io](http://webdriver.io/api/protocol/elementIdDisplayed.html) | |[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All | [github.com](https://github.com/admc/wd/blob/master/lib/commands.js#L1370) | |[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All | [www.rubydoc.info](http://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FElement:displayed%3F) | |[PHP](https://github.com/appium/php-client/releases/latest)| All | [github.com](https://github.com/appium/php-client/) | |[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All | [github.com](https://github.com/appium/appium-dotnet-driver/) | ## HTTP API Specifications ### Endpoint `GET /wd/hub/session/:session_id/element/:element_id/displayed` ### URL Parameters |name|description| |----|-----------| |session_id|ID of the session to route the command to| |element_id|ID of the element to check if it is displayed| ### JSON Parameters None ### Response Whether the element is displayed (`boolean`) ## See Also * [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementiddisplayed)