File Transfer

Improve this doc

This plugin allows you to upload and download files.

Repo: https://github.com/apache/cordova-plugin-file-transfer

Installation

1. Install the Cordova and Ionic Native plugins:
   

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

2. Add this plugin to your app's module

Supported platforms

• Amazon Fire OS
• Android
• Browser
• iOS
• Ubuntu
• Windows
• Windows Phone

Usage

import { FileTransfer, FileUploadOptions, FileTransferObject } from '@ionic-native/file-transfer';
import { File } from '@ionic-native/file';

constructor(private transfer: FileTransfer, private file: File) { }

...

const fileTransfer: FileTransferObject = this.transfer.create();

// Upload a file:
fileTransfer.upload(..).then(..).catch(..);

// Download a file:
fileTransfer.download(..).then(..).catch(..);

// Abort active transfer:
fileTransfer.abort();

// full example
upload() {
  let options: FileUploadOptions = {
     fileKey: 'file',
     fileName: 'name.jpg',
     headers: {}
     .....
  }

  fileTransfer.upload('<file path>', '<api endpoint>', options)
   .then((data) => {
     // success
   }, (err) => {
     // error
   })
}

download() {
  const url = 'http://www.example.com/file.pdf';
  fileTransfer.download(url, this.file.dataDirectory + 'file.pdf').then((entry) => {
    console.log('download complete: ' + entry.toURL());
  }, (error) => {
    // handle error
  });
}

To store files in a different/publicly accessible directory, please refer to the following link https://github.com/apache/cordova-plugin-file#where-to-store-files

Instance Members

FileTransferErrorCode

Error code rejected from upload with FileTransferError Defined in FileTransferError. FILE_NOT_FOUND_ERR: 1 Return when file was not found INVALID_URL_ERR: 2, Return when url was invalid CONNECTION_ERR: 3, Return on connection error ABORT_ERR: 4, Return on aborting NOT_MODIFIED_ERR: 5 Return on ‘304 Not Modified’ HTTP response

create()

Creates a new FileTransfer object

FileTransferObject

Instance Members

upload(fileUrl, url, options, trustAllHosts)

Sends a file to a server.

download(source, target, trustAllHosts, Optional)

Downloads a file from server.

onProgress(listener)

Registers a listener that gets called whenever a new chunk of data is transferred.

abort()

Aborts an in-progress transfer. The onerror callback is passed a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.

FileUploadOptions

FileUploadResult

FileTransferError