FTP

Improve this doc

This cordova plugin is created to use ftp (client) in web/js.

Repo: https://github.com/xfally/cordova-plugin-ftp

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-ftp
   $ npm install --save @ionic-native/ftp@4
   

2. Add this plugin to your app's module

Supported platforms

• Android
• iOS

Usage

import { FTP } from '@ionic-native/ftp';


constructor(private fTP: FTP) { }

...


this.fTP.connect('ftp_host', 'ftp_user', 'ftp_password')
  .then((res: any) => console.log('Login successful', res))
  .catch((error: any) => console.error(error));

Instance Members

connect(hostname, username, password)

Connect to one ftp server.

Just need to init the connection once. If success, you can do any ftp actions later.

ls(path)

List files (with info of name, type, link, size, modifiedDate) under one directory on the ftp server. You can get one file’s name using fileList[x].name (x is the location in array).

Explain key:

• name: file name (utf-8).
• type: file type. number 0 means regular file, 1 means directory, 2 means symbolic link, -1 means unknown type (maybe block dev, char dev…).
• link: if the file is a symbolic link, then this field store symbolic link information (utf-8), else it’s a blank string.
• size: file size in bytes.
• modifiedDate: modified date of this file. date format is yyyy-MM-dd HH:mm:ss zzz, e.g “2015-12-01 20:45:00 GMT+8”.

mkdir(path)

Create one directory on the ftp server.

rmdir(path)

Delete one directory on the ftp server.

Tip: As many ftp server could not rm dir when it’s not empty, so rm all files under the dir at first is recommended.

rm(file)

Delete one file on the ftp server.

upload(localFile, remoteFile)

Upload one local file to the ftp server.

download(localFile, remoteFile)

Download one remote file on the ftp server to local path.

cancel()

Cancel all requests. Always success.

disconnect()

Disconnect from ftp server.