Pull File
Retrieve a file from the device's file system
Example Usage
// Java
byte[] fileBase64 = driver.pullFile("/path/to/device/foo.bar");
# Python
file_base64 = self.driver.pull_file('/path/to/device/foo.bar');
// Javascript
// webdriver.io example
let data = driver.pullFile('/data/local/tmp/file.txt');
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
// wd example
let fileBase64 = await driver.pullFile('/path/to/device/foo.bar');
# Ruby
# ruby_lib example
pull_file('/data/local/tmp/file.txt')
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/files/pull-file.yml)
# ruby_lib_core example
@driver.pull_file('/data/local/tmp/file.txt')
# PHP
$data = $driver->pullFile('data/local/tmp/file.txt');
// C#
// TODO C# sample
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.2+ | All | All | |
| Mac | Mac | None | None | None |
| Windows | Windows | None | None | None |
Appium Clients
| Language | Support | Documentation |
|---|---|---|
| Java | All | appium.github.io |
| Python | All | github.com |
| Javascript (WebdriverIO) | All | |
| Javascript (WD) | All | github.com |
| Ruby | All | www.rubydoc.info |
| PHP | All | github.com |
| C# | All | github.com |
HTTP API Specifications
Endpoint
POST /wd/hub/session/:session_id/appium/device/pull_file
URL Parameters
| name | description |
|---|---|
| session_id | ID of the session to route the command to |
JSON Parameters
| name | type | description |
|---|---|---|
| path | string |
Path on the device to pull file from |
Response
Contents of file in base64 (string)