https://github.com/dsgriffin/ionic-3-file-transfer-example

:file_folder: File Transfer in Ionic 3 using Ionic Native's File and Transfer modules
https://github.com/dsgriffin/ionic-3-file-transfer-example

file-transfer ionic ionic3 javascript js typescript

Last synced: about 1 month ago
JSON representation

:file_folder: File Transfer in Ionic 3 using Ionic Native's File and Transfer modules

• Host: GitHub
• URL: https://github.com/dsgriffin/ionic-3-file-transfer-example
• Owner: dsgriffin
• Created: 2016-04-14T13:24:24.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-06-30T18:18:39.000Z (almost 7 years ago)
• Last Synced: 2024-05-03T06:14:04.263Z (about 1 month ago)
• Topics: file-transfer, ionic, ionic3, javascript, js, typescript
• Language: TypeScript
• Homepage:
• Size: 1.61 MB
• Stars: 112
• Watchers: 14
• Forks: 60
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Lists

• awesome-ionic2-components - Cordova File Transfer

README

        
![Logo](http://dsgriffin.github.io/images/logos/ionic-file-transfer-example.png)

![](https://img.shields.io/badge/ionic-3.5.0-green.svg)

A simple file transfer example in Ionic 3 using Ionic Native's

*  [Transfer](http://ionicframework.com/docs/native/transfer/) module to download a file to the local device

* And then, using the [File](http://ionicframework.com/docs/native/file/) module, retrieve that file



## Requirements

* File Transfer will not work on an emulator; you'll need an iOS or Android device

* If you're building/testing for/on iOS, you'll need XCode.

## Build

Clone the repository and follow the steps based on the platform of your device.

#### iOS

1. `npm install`

2. `cordova platform add ios`

3. `ionic cordova build ios`

4. Connect your iOS device and run the application, either by

  1. Opening up the relevant `.xcodeproj` on `Xcode` and clicking the run button (making sure your device is selected)

  2. Running `ionic cordova run ios --device` on your CLI - this requires that the npm package `ios-deploy` is installed globally (`npm install -g ios-deploy`)

### Android

1. `npm install`

2. `cordova platform add android`

3. `ionic cordova build android`

4. Connect your Android device and run the application with `ionic cordova run android` (make sure USB debugging is enabled on your device)

## File Transfer - Storage Locations

The `.jpg` used in this example is saved in different locations dependant on platform:

* **iOS** - in the app-specific `Documents/` folder using `cordova.file.documentsDirectory`

* **Android** - persistent and private data storage within the application's sandbox using `cordova.file.dataDirectory`

[Here's the list](https://github.com/apache/cordova-plugin-file#where-to-store-files) of the different places you can store files using this plugin.

## License

MIT