Skip to content
Michael Grenier edited this page Jan 24, 2015 · 1 revision

API for other package creator

Other package can access the FTP Client with atom.project.remoteftp.

Properties

  • info - (object) - Object containing the .ftpconfig's data
  • connector - (Connector) - object for raw access to the connector

Events

  • connected() - Connected to the server
  • closed() - Connection closed
  • ended() - Connection has ended
  • error(string error) - Connection had an error

Methods

  • readConfig(function callback) - (void) - Read .ftpconfig file
  • connect(bool reconnect) - (Client) - Initiate connection
  • disconnect() - (Client) - Close connection
  • isConnected() - (bool) - Check if connected
  • onceConnected(function callback) - (bool) - Try to reconnect and execute callback
  • abort() - (Client) - Abort single operation
  • abortAll() - (Client) - Abort all pending operation
  • list(string remote, bool recursive, function callback) - (Client) - Retrieve a list of resource at location
  • download(string remote, bool recursive, function callback) - (Client) - Download remote path to local
  • upload(string remote, function callback) - (Client) - Upload local path to remote
  • mkdir(string remote, bool recursive, function callback) - (Client) - Create a folder at remote
  • mkfile(string remote, function callback) - (Client) - Create empty file at remote
  • rename(string source, string destination, function callback) - (Client) - Rename remote to destination
  • delete(string remote, bool recursive, function callback) - (Client) - Delete remote location
Clone this wiki locally