React Native

SFTP Simplified Download

See more SFTP Examples

Demonstrates how to SFTP download a file by passing a remote filepath to DownloadFileByName. React Native

import { SFtp } from '@chilkat/react-native'

async function chilkatExample() {
  // This example assumes the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  const sftp = new SFtp();

  // Set some timeouts, in milliseconds:
  sftp.connectTimeoutMs = 15000;
  sftp.idleTimeoutMs = 15000;

  // Connect to the SSH server.  
  // The standard SSH port = 22
  // The hostname may be a hostname or IP address.
  const hostname = 'sftp.example.com';
  const port = 22;
  try {
    await sftp.connectAsync(hostname, port);
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Authenticate with the SSH server.  Chilkat SFTP supports
  // both password-based authenication as well as public-key
  // authentication.  This example uses password authenication.
  try {
    await sftp.authenticatePwAsync('myLogin', 'myPassword');
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // After authenticating, the SFTP subsystem must be initialized:
  try {
    await sftp.initializeSftpAsync();
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Download the file:
  const localFilePath = 'c:/temp/hamlet.xml';
  // Note: The remote filepath may be an absolute filepath,
  // a relative filepath, or simply a filename.  
  // Relative filepaths are always relative to the home directory
  // of the SFTP/SSH user account.  There is no such thing
  // as "current remote directory" in the SFTP protocol. 
  // A filename with no path implies that the file is located
  // in the SFTP user account's home directory.
  const remoteFilePath = 'subdir1/subdir2/hamlet.xml';
  try {
    await sftp.downloadFileByNameAsync(remoteFilePath, localFilePath);
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  console.log('Success.');
}