Puts the application in the background on the device for a certain duration.

Takes a screenshot of the current page and embeds it into the log.

filenameargument specifies the name of the file to write the screenshot into. If nofilenameis given, the screenshot is saved into fileappium-screenshot-<counter>.pngunder the directory where the Robot Framework log file is written into. Thefilenameis also considered relative to the same directory, if it is not given in absolute format.

csscan be used to modify how the screenshot is taken. By default the bakground color is changed to avoid possible problems with background leaking when the page layout is somehow broken.

Clears the text field identified bylocator.

Seeintroductionfor details about locating elements.

Click button

Click element identified bylocator.

Key attributes for arbitrary elements areindexandname. Seeintroductionfor details about locating elements.

Closes all open applications.

This keyword is meant to be used in test or suite teardown to make sure all the applications are closed before the test execution finishes.

After this keyword, the application indices returned byOpen Applicationare reset and start from1.

Closes the current application.

Verifies that element identified with locator is disabled.

Key attributes for arbitrary elements areidandname. Seeintroductionfor details about locating elements.

Verifies that element identified with locator is enabled.

Key attributes for arbitrary elements areidandname. Seeintroductionfor details about locating elements.

Get available contexts.

Get current context.

Returns an integer bitmask specifying the network connection type. Android only. Seeset network connection statusfor more details.

Returns the entire source of the current page.

Goes one step backward in the browser history.

Opens URL in default web browser.

Example:

Hides the software keyboard on the device, using the specified key to press. If no key name is given, the keyboard is closed by moving focus from the text field. iOS only.

Types the given password into text field identified bylocator.

Difference between this keyword andInput Textis that this keyword does not log the given password. Seeintroductionfor details about locating elements.

Types the giventextinto text field identified bylocator.

Seeintroductionfor details about locating elements.

Sets the given value into text field identified bylocator. This is an IOS only keyword, input value makes use of set_value

Seeintroductionfor details about locating elements.

Lock the device

Logs and returns the entire html source of the current page or frame.

Theloglevelargument defines the used log level. Valid log levels areWARN,INFO(default),DEBUG,TRACEandNONE(no logging).

Long press the element

Sends a long press of keycode to the device. Android only. Seepress keycodefor more details.

Opens a new application to given Appium server. Capabilities of appium server, Android and iOS, Please checkhttp://appium.io/slate/en/master/?python#appium-server-capabilities

Examples:

Verifies that current page containslocatorelement.

If this keyword fails, it automatically logs the page source using the log level specified with the optionalloglevelargument. Givin

Verifies that current page containstext.

If this keyword fails, it automatically logs the page source using the log level specified with the optionalloglevelargument. GivingNONEas level disables logging.

Verifies that current page not containslocatorelement.

If this keyword fails, it automatically logs the page source using the log level specified with the optionalloglevelargument. Givin

Verifies that current page not containstext.

If this keyword fails, it automatically logs the page source using the log level specified with the optionalloglevelargument. GivingNONEas level disables logging.

Pinch in on an element a certain amount.

Sends a press of keycode to the device. Android only. Possible keycodes & meta states can be found inhttp://developer.android.com/reference/android/view/KeyEvent.html

Meta state describe the pressed state of key modifiers such as Shift, Ctrl & Alt keys. The Meta State is an integer in which each bit set to 1 represents a pressed meta key. For example META_SHIFT_ON = 1 META_ALT_ON = 2 MetaState=1 --> Shift is pressed MetaState=2 --> Alt is pressed MetaState=3 --> Shift+Alt is pressed

:Args:

• keycode - the keycode to be sent to the device
• metastate - status of the meta keys

Retrieves the file atpathand return it's content. Android only.

:Args:

• path - the path to the file on the device
• decode - True/False decode the data (base64) before returning it (default=False)

Retrieves a folder atpath. Returns the folder's contents zipped. Android only.

:Args:

• path - the path to the folder on the device
• decode - True/False decode the data (base64) before returning it (default=False)

Puts the data in the file specified aspath. Android only.

:Args:

• path - the path on the device
• data - data to be written to the file
• encode - True/False encode the data as base64 before writing it to the file (default=False)

Sets the keyword to execute when a AppiumLibrary keyword fails.

keyword_nameis the name of a keyword (from any available libraries) that will be executed if a AppiumLibrary keyword fails. It is not possible to use a keyword that requires arguments. Using the value "Nothing" will disable this feature altogether.

The initial keyword to use is set inimporting, and the keyword that is used by default isCapture Page Screenshot. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.

This keyword returns the name of the previously registered failure keyword. It can be used to restore the original value later.

Example:

This run-on-failure functionality only works when running tests on Python/Jython 2.4 or newer and it does not work on IronPython at all.

Removes the application that is identified with an application id

Example:

Reset application

Scrolls from one element to another Key attributes for arbitrary elements areidandname. Seeintroductionfor details about locating elements.

Sets the network connection Status. Android only. Possible values: Value |(Alias) | Data | Wifi | Airplane Mode

0 |(None) | 0 | 0 | 0 1 |(Airplane Mode) | 0 | 0 | 1 2 |(Wifi only) | 0 | 1 | 0 4 |(Data only) | 1 | 0 | 0 6 |(All network on) | 1 | 1 | 0

Shake the device

Swipe from one point to another point, for an optional duration.

Switches the active application by index or alias.

index_or_aliasis either application index (an integer) or alias (a string). Index is got as the return value ofOpen Application.

This keyword returns the index of the previous active application, which can be used to switch back to that application later.

Example:

Switch to a new context

Tap on element

Waits untiltextappears on current page.

Fails iftimeoutexpires before the text appears. Seeintroductionfor more information abouttimeoutand its default value.

errorcan be used to override the default error message.

See alsoWait Until Page Does Not Contain,Wait Until Page Contains Element,Wait Until Page Does Not Contain Elementand BuiltIn keywordWait Until Keyword Succeeds.

Waits until element specified withlocatorappears on current page.

Fails iftimeoutexpires before the element appears. Seeintroductionfor more information abouttimeoutand its default value.

errorcan be used to override the default error message.

See alsoWait Until Page Contains,Wait Until Page Does Not ContainWait Until Page Does Not Contain Elementand BuiltIn keywordWait Until Keyword Succeeds.

Waits untiltextdisappears from current page.

Fails iftimeoutexpires before thetextdisappears. Seeintroductionfor more information abouttimeoutand its default value.

errorcan be used to override the default error message.

See alsoWait Until Page Contains,Wait Until Page Contains Element,Wait Until Page Does Not Contain Elementand BuiltIn keywordWait Until Keyword Succeeds.

Waits until element specified withlocatordisappears from current page.

Fails iftimeoutexpires before the element disappears. Seeintroductionfor more information abouttimeoutand its default value.

errorcan be used to override the default error message.

See alsoWait Until Page Contains,Wait Until Page Does Not Contain,Wait Until Page Contains Elementand BuiltIn keywordWait Until Keyword Succeeds.

Zooms in on an element a certain amount.