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

  Edit this Doc Get Clipboard

Get the content of the system clipboard

Example Usage

driver.getClipboard(ClipboardContentType.PLAINTEXT); // get plaintext
driver.getClipboardText();

self.driver.get_clipboard()
self.driver.get_clipboard_text()

// webdriver.io example
driver.getClipboard();

// wd example
await driver.getClipboard();

# ruby_lib example
get_clipboard

# ruby_lib_core example
@driver.get_clipboard

// CSharp Code here

Description

Get the content of the system clipboard

(For iOS 13+ real devices) Apple security preferences require the WebDriverAgentRunner application to be in foreground in order to be able to receive the system clipboard content. Otherwise an empty string is always returned. Consider using Activate App and Background App to change the foreground application. Activate App command cannot launch the WebDriverAgent properly on some environments. It depends on XCTest framework by Apple. Then, you should launch the WebDriverAgent using its Springboard's application icon. Follow the example below. 1. Open Springboard, @driver.activate_app 'com.apple.springboard'. 2. Find the WDA icon with @driver.find_element :accessibility_id, 'WebDriverAgentRunner-Runner' (It should be visible on the screen) and click it. 3. Call the get clipboard API. 4. Open the application under test with the Activate App.

Support

Appium Server

Appium Clients

HTTP API Specifications

Endpoint

POST /session/:session_id/appium/device/get_clipboard

URL Parameters

JSON Parameters

Response

Clipboard content as base64-encoded string or an empty string if the clipboard is empty (string)

See Also