https://github.com/dsgriffin/ionic-3-file-transfer-example
File Transfer in Ionic 3 using Ionic Native's File and Transfer modules :file_folder:
https://github.com/dsgriffin/ionic-3-file-transfer-example
file-transfer ionic ionic3 javascript js typescript
Last synced: 2 months ago
JSON representation
File Transfer in Ionic 3 using Ionic Native's File and Transfer modules :file_folder:
- Host: GitHub
- URL: https://github.com/dsgriffin/ionic-3-file-transfer-example
- Owner: dsgriffin
- License: mit
- Archived: true
- Created: 2016-04-14T13:24:24.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-12-29T21:39:47.000Z (5 months ago)
- Last Synced: 2025-01-13T21:02:07.086Z (5 months ago)
- Topics: file-transfer, ionic, ionic3, javascript, js, typescript
- Language: TypeScript
- Homepage:
- Size: 1.62 MB
- Stars: 112
- Watchers: 14
- Forks: 60
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Awesome - Cordova File Transfer
README
# Ionic 3 File Transfer Example 📁
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.
## Contributing
If you've found a bug or have an idea, feel free to open an Issue. If you've got a fix or feature ready, open a PR. Thanks!
## License
MIT