Documentation | Appery.io

The Appery.io Developer Hub

Welcome to the Apperyio developer hub. You'll find comprehensive guides and documentation to help you start working with apperyio as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    

Ionic 4 File Upload App using Cordova plugins

This tutorial describes how to create an Ionic 4 app that can upload files from the device to the Firebase project storage using the Cordova plugins.

👍

Important notice

Be informed that when creating an app with Cordova plugins it is important that the needed plugin be imported before you proceed with the app UI or create it from a backup.

Part 1. Importing Plugins

First of all, let's import three Cordova plugins that will be used in the app.

Importing cordova-plugin-file-opener2

  1. Log in to Appery.io and from the Appery.io dashboard, navigate to Resources > Cordova plugins tab.
  2. Click Import Cordova plugin and select the From Git tab.
  3. Enter https://github.com/pwlin/cordova-plugin-file-opener2 in the Repository URL field.
  4. Enter master in the Repository branch field and click the Import plugin button.

Importing cordova-plugin-filepath

  1. Under the Resources > Cordova plugins tab, click Import Cordova plugin and select the From Git tab.
  2. Enter https://github.com/hiddentao/cordova-plugin-filepath in the Repository URL field.
  3. Enter master in the Repository branch field and click the Import plugin button.

Importing cordova-filechooser

  1. Click Import Cordova plugin once again and select the From Git tab.
  2. Enter https://github.com/ihadeed/cordova-filechooser.git in the Repository URL field.
  3. Enter master in the Repository branch field and click the Import plugin button.

All the plugins should now be added to the list of Cordova plugins:

Cordova Plugins Added

Part 2. Defining Firebase Project

  1. Sign up to https://firebase.google.com and create a new project.
  2. Go to the Project settings tab:

Firebase project settings

  1. In the Your apps section, select the WEB platform icon for your new app:
  1. Then register your app nickname:
  1. The page with your Firebase SDK opens. It will be used for your Appery.io project later.
  2. Now, go to the Storage tab and click Get started to set the rules:
  1. Click Next to proceed with publishing the rules.
  2. To finish with setting up the Firebase storage, let's remove the string : if request. auth ! = null from the rules code to allow unrestricted access to the database:

Modified Storage Rules

🚧

Note that if you keep the default rules, the access to the database will be restricted and only the users with permissions described in this database will be able to write to and/or read from it.

Part 3. Creating App

  1. Go to the Apps tab and click Create new app.
  2. Select Ionic 4 > Ionic 4 Blank for the application type, enter the app name, for example, FileUploadApp, and click Create.

Enabling Cordova Plugins

  1. Inside the app, navigate to Project > App Settings > Cordova plugins.
  2. Select the Core Cordova plugins tab, then select the File plugin:
  1. Now, switch to the Imported Cordova plugins tab and select the File Opener 2, FileChooser, and the cordova-plugin-filepath plugins, then click the SAVE button at the top:

Adding Dependencies

  1. Go to Project > App settings > Npm modules and add 4 new Dependencies:
  • @angular/fire of version = 5.2.1
  • firebase of version = 7.2.2
  • @ionic-native/file-chooser
  • @ionic-native/file-path:
  1. Now, unfold the Pages folder and choose the app page.
  2. Go to the page MODULE tab. In the Imports section, add the following modules:
import { AngularFireModule } from '@angular/fire';
import { AngularFirestoreModule } from '@angular/fire/firestore';
import { AngularFireDatabaseModule } from '@angular/fire/database';
import { AngularFireStorageModule } from '@angular/fire/storage';
  1. Now, go back to your Firebase project Settings page (check step 5 of the # Part 2. Defining the Firebase Project section of this tutorial), scroll down to the Your apps section and select Config:
  1. Copy and paste the script into the Pages > app > Module > NgModule Settings > Imports field replacing the first line of the config codeconst firebaseConfig = by AngularFireModule.initializeApp( and its closing ; by ),. Then, add these two lines below:
AngularFirestoreModule, 
AngularFireStorageModule

Here is the sample code to be added to the Imports field:

AngularFireModule.initializeApp({
  apiKey: "TestCodeTestCodeTestCodeTestCode",
  authDomain: "test-project-TestCode-firebaseapp.com",
  databaseURL: "https://test-project-5b77f.firebaseio.com",
  projectId: "test-project-5b77f",
  storageBucket: "test-project-5b77f.appspot.com",
  messagingSenderId: "306524925173",
  appId: "1:TestCode:web:TestCodeTestCodeTestCode"
  }),
AngularFirestoreModule, 
AngularFireStorageModule

When ready, the NgModule Settings > Imports value field should be defined like the one in the screenshot:

Defining App Logic

  1. Click CREATE NEW > TypeScript, name it fireBaseService and click Create Script with entering the following code:
import { Injectable } from '@angular/core';
import {AngularFireDatabase} from "@angular/fire/database";

import {AngularFireStorage} from "@angular/fire/storage";

export interface Idea {
  id?: string,
  name: string,
  notes: string
}

@Injectable()
class FireBaseService {
    
    constructor(private af: AngularFireStorage){}

    
    async uploadFileToStorage(file, type, name) {
        const randomId = Math.random()
            .toString(36)
            .substring(2, 8);

        let oMyBlob = new Blob([file], {type : type})
        
        const uploadTask = this.af.upload(
            `files/${new Date().getTime()}_${randomId}_${name}`,
            oMyBlob
        );
    
        uploadTask.then(async res => {
            console.log('file upload finished!');
        }).catch(err =>  {
            console.log('file wasnt upload. Error: ' + err);
        });
    }
    
}

export { FireBaseService as ExportedClass };
  1. Open Pages > Screen1 > MODULE tab and add the below code to the Imports section:
import { FileChooser } from '@ionic-native/file-chooser/ngx';
import { FilePath } from '@ionic-native/file-path/ngx';

Here is how it should look like:

  1. Now, scroll down and add the below code for the Providers value:

FileChooser , FilePath .

  1. Open Pages > Screen1 > CODE, click the Edit internal includes button and select the { File } and fireBaseService dependencies. Click Save:
  1. Now, add two custom includes:
    {FileChooser} with path @ionic-native/file-chooser/ngx
    {FilePath} with path @ionic-native/file-path/ngx:
  1. Finally, scroll down to the Variables section and add the next variables:
  • fireService of fireBaseService type
  • getFile of FileChooser type
  • myFile of File type
  • fileForSending of Any type.
    Next, one by one add the following variables, all of String type:
  • pathConverter
  • fileUri
  • filePath
  • fileName
  • fileType.

Lastly, add the entry variable of Any type.

Please note that the Add DI checkbox should be checked for the fireService, getFile, myFile, and pathConverter variables:

Creating App UI

  1. Go to the Screen 1 DESIGN tab and, under the PROPERTIES tab, set the Footer property to False, then select the Header ToolbarTitle element and change its Text property to File Upload App.
  2. Drag & drop a Button from PALETTE and set its Text property to Upload File to Firebase. Then, expand the EVENTS panel from the bottom, select the Click event for the button and set Run TypeScript for its action.
  3. Enter the following code into the code editor and save:
this.getFile.open()
.then(uri => {
    //getting URI of a choosen file
    this.fileUri = uri;
    return this.myFile.resolveLocalFilesystemUrl(this.fileUri);
}).then(fileEntry => {
    this.entry = fileEntry;
    this.entry.file((arg) => {
        //getting mime type of a file
        this.fileType = arg.type;
    })
}).then(() => {
    return this.pathConverter.resolveNativePath(this.fileUri)
}).then((filePath) => {
    //converting file URI to normal file PATH & file NAME
    this.filePath = filePath.substring(0, filePath.lastIndexOf('/'));
    this.fileName = filePath.substring(filePath.lastIndexOf('/'), filePath.length).replace("/", "");
}).then(() => {
    return this.myFile.readAsArrayBuffer(this.filePath, this.fileName)
}).then((file) => {
    //getting file 
    this.fireService.uploadFileToStorage(file, this.fileType, this.fileName);
})
.catch(err =>  {
    console.log('error: ', err)
});

Here is how the event should look like in the Visual Builder:

That's it! You can save the project now and proceed with testing.

App Testing

  1. Click the EXPORT button in the top menu of the Appery.io Visual Editor.
  2. Select Binary (.apk) or Binary (.ipa) and wait a bit while the app is being built.
  3. When the app is ready, install it on your device, run the application and try uploading local files to your Firebase project storage.

👍

Note that before you can use the app, you will also need to allow taking photos, recording videos and accessing photos, media, and files on your device.

  1. Now, open the Files tab of your Firebase project storage or update the page to check that the picture has been loaded successfully:

Updated 6 months ago

Ionic 4 File Upload App using Cordova plugins


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.