Download

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Altri servizi > FTP >

Download

Service

FTP

 

Method

Download

 

Description

Downloads the specified file or directory hierarchy from the FTP server to the local directory. Wildcards are allowed.

 

Input

Name

Description

Type

Optional

remotePath

The path (with or without wildcards) of the remote file or directory.

String

 

localDirectoryPath

The path of the local directory.

String

 

traversalMode

Traversal mode. Specifies whether the whole hierarchy or files only are transferred.

Int

 

actionOnExistingFiles

Specifies the behavior for files that already exists at the local directory.

Int

 

 

Remarks

Traversal mode: specifies how to traverse a hierarchy of directories.

 

0 = Recursive

Do RECURSIVE transfer of matching directories.

If the pattern matches a file, the file is processed.

If the pattern matches a directory, all files and subdirectories are processed.

1 = NonRecursive

Do NON-RECURSIVE transfer of matching directories.

If the pattern matches a file, the file is processed.

If the pattern matches a directory, only the directory itself is processed (an empty directory will be created).

2 = FilesRecursive

This is the same as Recursive mode, but only files are processed.

Files are searched in the given directory and also in all its subdirectories.

3 = FilesNonRecursive

This is the same as NonRecursive mode, but only files are processed.

Files are searched only in the first level of given directory.

 

Action on existing files: specifies the action to perform when a target file already exists.

 

0 = OverwriteAll

Existing files are to be always overwritten.

1 = OverwriteDifferentSize

Existing files with different sizes are to be overwritten.

2 = SkipAll

Existing files are to be always skipped.

3 = ResumeIfPossible

Existing files are to be resumed if they are smaller than source files.

4 = ThrowException

Existing files are to cause the whole multi-file transfer to be canceled and an exception to be raised.