api.md

Protractor API

Note: in this documentation, protractor and webdriver refer to namespaces, and ptor and driver refer to instances of the Protractor and Webdriver classes.

Protractor is a wrapper around WebDriver, so anything available on WebDriver is available on Protractor. The best documentation for both is the code itself. This file provides an overview and links on where to get more information.

API methods and members that are modified or added by Protractor are marked with a P.

Documentation generated at 8580c0c76c5ccd3c55d053e59d8df37b3c4cf35a

WebDriver and Protractor

WD : controlFlow function( ) -> !webdriver.promise.ControlFlow

WD : schedule function( !webdriver.Command string ) -> !webdriver.promise.Promise

WD : getSession function( ) -> !webdriver.promise.Promise

WD : getCapabilities function( ) -> !webdriver.promise.Promise

WD : getCapability function( string ) -> !webdriver.promise.Promise

WD : quit function( ) -> !webdriver.promise.Promise

WD : actions function( ) -> !webdriver.ActionSequence

WD : executeScript function( !(string|Function) ...* ) -> !webdriver.promise.Promise

WD : executeAsyncScript function( !(string|Function) ...* ) -> !webdriver.promise.Promise

WD : call function( !Function Object= ...* ) -> !webdriver.promise.Promise

WD : wait function( function():boolean number string= ) -> !webdriver.promise.Promise

WD : sleep function( number ) -> !webdriver.promise.Promise

WD : getWindowHandle function( ) -> !webdriver.promise.Promise

WD : getAllWindowHandles function( ) -> !webdriver.promise.Promise

WD : getPageSource function( ) -> !webdriver.promise.Promise

WD : close function( ) -> !webdriver.promise.Promise

WD P : get function( string ) -> !webdriver.promise.Promise

WD : getCurrentUrl function( ) -> !webdriver.promise.Promise

WD : getTitle function( ) -> !webdriver.promise.Promise

WD : findElement function( !(webdriver.Locator|Object.<string>|Element) ... ) -> !webdriver.WebElement

WD : findDomElement_ function( !Element ) -> !webdriver.promise.Promise

WD : isElementPresent function( !(webdriver.Locator|Object.<string>|Element) ... ) -> !webdriver.promise.Promise

WD : findElements function( webdriver.Locator|Object.<string> ... ) -> !webdriver.promise.Promise

WD : takeScreenshot function( ) -> !webdriver.promise.Promise

WD : manage function( ) -> !webdriver.WebDriver.Options

WD : navigate function( ) -> !webdriver.WebDriver.Navigation

WD : switchTo function( ) -> !webdriver.WebDriver.TargetLocator

P : waitForAngular function( ) -> !webdriver.promise.Promise

P : wrapWebElement function( webdriver.WebElement )

P : addMockModule function( !string !string|Function )

P : clearMockModules function( )

P : debugger function( )

Locator Strategies

The findElement, findElements, and isElementPresent functions take a locator strategy as their parameter. The following locator strategies are avaiable)

: Protractor.By.id function( )

: Protractor.By.css function( )

: Protractor.By.xpath function( )

: Protractor.By.name function( )

: Protractor.By.tagName function( )

: Protractor.By.className function( )

: Protractor.By.linkText function( )

: Protractor.By.partialLinkText function( )

: Protractor.By.js function( )

P : Protractor.By.binding function( )

P : Protractor.By.select function( )

P : Protractor.By.selectedOption function( )

P : Protractor.By.input function( )

P : Protractor.By.model function( )

P : Protractor.By.textarea function( )

P : Protractor.By.repeater function( )

WebElements

The findElement, findElements, and isElementPresent functions return a WebElement object. The following functions are available on WebElements.

WD : WebElement.getDriver function( ) -> !webdriver.WebDriver

WD : WebElement.toWireValue function( ) -> !webdriver.promise.Promise

WD : WebElement.schedule_ function( !webdriver.Command string ) -> !webdriver.promise.Promise

WD P : WebElement.findElement function( webdriver.Locator|Object.<string> ... ) -> webdriver.WebElement

WD P : WebElement.isElementPresent function( webdriver.Locator|Object.<string> ... ) -> !webdriver.promise.Promise

WD P : WebElement.findElements function( webdriver.Locator|Object.<string> ... ) -> !webdriver.promise.Promise

WD : WebElement.click function( ) -> !webdriver.promise.Promise

WD : WebElement.sendKeys function( ...string ) -> !webdriver.promise.Promise

WD : WebElement.getTagName function( ) -> !webdriver.promise.Promise

WD : WebElement.getCssValue function( string ) -> !webdriver.promise.Promise

WD : WebElement.getAttribute function( string ) -> !webdriver.promise.Promise

WD : WebElement.getText function( ) -> !webdriver.promise.Promise

WD : WebElement.getSize function( ) -> !webdriver.promise.Promise

WD : WebElement.getLocation function( ) -> !webdriver.promise.Promise

WD : WebElement.isEnabled function( ) -> !webdriver.promise.Promise

WD : WebElement.isSelected function( ) -> !webdriver.promise.Promise

WD : WebElement.submit function( ) -> !webdriver.promise.Promise

WD : WebElement.clear function( ) -> !webdriver.promise.Promise

WD : WebElement.isDisplayed function( ) -> !webdriver.promise.Promise

WD : WebElement.getOuterHtml function( ) -> !webdriver.promise.Promise

WD : WebElement.getInnerHtml function( ) -> !webdriver.promise.Promise

P : WebElement.all function( )

P : WebElement.$ function( string ) -> !webdriver.WebElement

P : WebElement.$$ function( string ) -> !webdriver.promise.Promise

P : WebElement.evaluate function( string ) -> !webdriver.promise.Promise