This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Are Elements Equal

Test if two element IDs refer to the same element

Example Usage

// Overrides the Java Object .equals method
MobileElement elementOne = (MobileElement) driver.findElementByClassName("SomeClassName");
MobileElement elementTwo = (MobileElement) driver.findElementByClassName("SomeOtherClassName");
boolean isEqual = elementOne.equals(elementTwo);

# TODO Python sample

// example
let elementOne = $("someClass");
let elementTwo = $("someOtherClass");
let isEqual = elementOne.isEqual(elementTwo);

// wd example
let elementOne = await driver.elementByClassName("someClass");
let elementTwo = await driver.elementByClassName("someOtherClass");
let isEqual = await elementOne.equalsElement(elementTwo);

# ruby_lib example
element1 = find_element :class_name, "someClass"
element2 = find_element :class_name, "someOtherClass"
element1 == element2

# ruby_lib_core example
element1 = @driver.find_element :class_name, "someClass"
element2 = @driver.find_element :class_name, "someOtherClass"
element1 == element2

var elementOne = driver.FindElementByClassName("SomeClassName");
var elementTwo = driver.FindElementByClassName("SomeOtherClassName");
bool isEqual = elementOne.Equals(elementTwo);


Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest None None None
UIAutomation 8.0 to 9.3 All All
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.3+ All All
Mac Mac ?+ 1.6.4+ All
Windows Windows 10+ 1.6.0+ All

Appium Clients

Language Support Documentation
Java All
Python All
Javascript (WebdriverIO) All
Javascript (WD) All
Ruby All
C# All

HTTP API Specifications


GET /session/:session_id/element/:element_id/equals/:other_element_id

URL Parameters

name description
session_id ID of the session to route the command to
element_id ID of the element
element_id ID of the other element to check if they're equal

JSON Parameters



Whether the two ID's refer to the same element (boolean)

See Also