This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.
Edit this Doc Pull Folder
Retrieve a folder from the device's file system
Example Usage
byte[] folder = driver.pullFolder("/path/to/device/foo.bar");
folder_base64 = self.driver.pull_folder('/path/to/device/foo.bar');
// webdriver.io example
let data = driver.pullFolder('/data/local/tmp/file.txt');
// wd example
let folderBase64 = await driver.pullFolder('/path/to/device/foo.bar');
# ruby_lib example
pull_folder('/data/local/tmp/file.txt')
# ruby_lib_core example
@driver.pull_folder('/data/local/tmp/file.txt')
byte[] folder = driver.PullFolder("/path/to/device");
Support
Appium Server
| Platform | Driver | Platform Versions | Appium Version | Driver Version |
|---|---|---|---|---|
| iOS | XCUITest | 9.3+ | 1.6.0+ | All |
| 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 | None | None | None |
| Windows | Windows | None | None | None |
Appium Clients
| Language | Support | Documentation |
|---|---|---|
| Java | All | appium.github.io |
| Python | All | appium.github.io |
| Javascript (WebdriverIO) | All | |
| Javascript (WD) | All | github.com |
| Ruby | All | www.rubydoc.info |
| C# | All | github.com |
HTTP API Specifications
Endpoint
POST /session/:session_id/appium/device/pull_folder
URL Parameters
| name | description |
|---|---|
| session_id | ID of the session to route the command to |
JSON Parameters
| name | type | description |
|---|---|---|
| path | string |
Path to an entire folder on the device |
Response
A string of Base64 encoded data, representing a zip archive of the contents of the requested folder. (string)