Skip to content

Commit

Permalink
add ifues description
Browse files Browse the repository at this point in the history
  • Loading branch information
KazuCocoa committed Mar 12, 2019
1 parent 6ed85d7 commit 175ab43
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions lib/appium_lib_core/common/base/driver.rb
Original file line number Diff line number Diff line change
Expand Up @@ -426,12 +426,17 @@ def push_file(path, filedata)
# of the corresponding application container.
# Otherwise the root folder is considered as / on Android and on iOS it is a media folder root
# (real devices only).
# Only pulling files from application containers is supported for iOS Simulator.
# Provide the remote path in format <code>@bundle.identifier:container_type/relative_path_in_container</code>
# (Make sure this in ifuse doc)
#
# @return [Base64-decoded] Base64 decoded data
#
# @example
#
# @driver.pull_file '/local/data/some/path' #=> Get the file at that path
# @driver.pull_file 'Shenanigans.app/some/file' #=> Get 'some/file' from the install location of Shenanigans.app
# @driver.pull_file '@com.appium.example/Documents/file.txt' #=> Get 'file.txt' in @com.appium.example/Documents
#
def pull_file(path)
@bridge.pull_file(path)
Expand All @@ -444,20 +449,26 @@ def pull_file(path)
# its container on the internal file system.
#
# {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
#
# {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
#
# {https://developer.android.com/studio/debug/ 'Debug Your App' developer article}
#
# @param [String] path Absolute path to the folder.
# If the path starts with <em>@applicationId/</em> prefix, then the folder will be pulled
# from the root of the corresponding application container.
# Otherwise the root folder is considered as / on Android and on iOS it is a media folder root
# (real devices only).
# Only pulling files from application containers is supported for iOS Simulator.
# Provide the remote path in format <code>@bundle.identifier:container_type/relative_path_in_container</code>
# (Make sure this in ifuse doc)
#
# @return [Base64-decoded] Base64 decoded data which is zip archived
#
# @example
#
# @driver.pull_folder '/data/local/tmp' #=> Get the folder at that path
# @driver.pull_file '@com.appium.example/Documents' #=> Get 'Documents' in @com.appium.example
#
def pull_folder(path)
@bridge.pull_folder(path)
Expand Down

0 comments on commit 175ab43

Please sign in to comment.