README.md

nativescript-background-task

Run background task

Attention!! this plugin not is registered on npm. To use you should add the repository directly on your package.json:

dependencies: {
    "nativescript-background-task": "https://github.com/mobilemindtec/nativescript-background-task.git"
}

Features

• unzip file
• download big files, supports partial/resume download
• move many files
• save large file
• post large file base64 gzip json or form data (base64 gzip)
• split large file
• run sql batch (insert, update, delete)

** IOS Pod code at http://github.com/mobilemindtec/nativescript-background-task-ios-source

Configs

Android

Add at app.gradle

allprojects {
    repositories {
        jcenter()
        mavenCentral()
        maven {
            url "https://raw.githubusercontent.com/mobilemindtec/m2/master"
        }
    }
}

android {
	useLibrary 'org.apache.http.legacy'
}
dependencies{
  compile('br.com.mobilemind.api:mobilemind-droid-util:1.4', {
      exclude group: 'com.google.android', module: 'android'
      exclude group: 'com.google.android', module: 'support-v4'
      exclude group: 'br.com.mobilemind.api', module: 'mobilemind-utils'
  })
  compile 'br.com.mobilemind.api:mobilemind-utils:1.3'
}

Using

var BackgroundTask = require("nativescript-background-task")

Unzip file

BackgroundTask.unzip({
	fromFile: zipFile,
	toFile: extractPath,
	doneCallback: function(){
		// done			
	},
	errorCallback: function(error){
		// error			
	},
})

Download to file

if you set checkPartialDownload: true the plugin will test, using HEAD request to know if server accepts (header Accept-Ranges: bytes). If server supports, the plugin make partial download of partBytesSize bytes (default is 2MB). Partial download enable resume download if some part of download already done. The server can supports HEAD request to work.

BackgroundTask.getFile({
	url: 'http://www.mobilemind.com.br/makeyourself/coollife/images-2.1.zip',
	toFile: destinationFile,
	identifier: 1,
        partBytesSize: 0, // use default 2MB
        checkPartialDownload: true,	
	headers: [
		{ 'CustonHeader': 'Custon Value' }
	],	
	doneCallback: function(identifier){
		// done
	},
	errorCallback: function(error){
		var identifier = error[0]
		var message = error[1]
		// error
	},
})

Copy many files to destination directory

BackgroundTask.copyFiles({
	fromFile: extractPath,
	toFile: movePath,
	doneCallback: function(){
		// done						
	},
	errorCallback: function(){
		// error			
	},
})

Save a or copy a large file or Image to destination.

You can set Image or file source

var files = []
files.push({
	image: image, // to save android Bitmap, ios UIImage or nativescript Image
	fileDst: fileDst, // destination file path
	fileSrc: doc.fileSrc, // to pdf or another doc.. copy to destination
	quality: 30 // quality if is bitmap
})
BackgroundTask.saveLargeFiles({
	files: files
	doneCallback: function(){
		// done
	},
	errorCallback: function(error){
		// error
	}
})

Post files

Post a file using json format or form data.

• JSON format - To post json files, you need provide a key that the content will be stored in json object. For example, if you set jsonKey: 'photo' the plugin make a json { photo: 'photo content' } and add in photo content the file content using Base64 and, if you want GZip.

• Form Data - To post Form Data, you need provide a key that the content will be stored in form data. For example, if you set jsonKey: 'photo' the plugin make a form data dataform[jsonKey] = 'photo content' and add in photo content the file content using Base64 and, if you want GZip.

The file always will be store in jsonKey field, and not in post content. The server need supports this logic.

  BackgroundTask.postFiles({
    url: apiUrl, // api url
    formData: false, // use form data to post. default is json
    gzip: true, // use base64 gzip
    items: [{    	
      fileSrc: fileSrc, // file origin path
      jsonKey: jsonKey, // internally post data[jsonKey] = file content
      identifier: identifier, // identifier to result
      data: { // you json object to post + data[jsonKey] = file content
	Id: 1
      }              
    }],
    headers: [
      { 'X-Auth-Token': token }                       
    ],
    doneCallback: function(dataPostList) {

      // to ios use array converter
      // var utils require("utils/utils")
      // if(application.ios)
      //  dataPostList = utils.ios.collections.nsArrayToJSArray(dataPostList)

    	for(var i in dataPostList){
		var postData = dataPostList[i]
		var data = JSON.parse(postData.result)
		var identifier = postData.identifier
		// get response headers names postData.getHeaderNames()
		// get response header value postData.getHeaderValue("name")
		// get response headers postData.getHeaders()
		// get response object postData.response
		// process result
	}
    },
    errorCallback: function(error){
    	// error
    }
})

SQL Batch

Execute sql back in background.

// sql batch
var items = []

// insert / update / delete
items.push({
	query: 'insert into foo name values(?)',
	args: ['john']
})

// to insert or update
items.push({
	insertQuery: 'insert into foo name values(?)',
	updateQuery: 'update foo set name = ? where id = ?',
	tableName: 'foo',
	updateKey: 'id',
	updateKeyValue: '1',
	args: ['john']
})

BackgroundTask.dbBatch({
	dbName: dbName,
	items: items,
	doneCallback: function(){
		// done
	},
	errorCallback: function(error){
		// error
	}
})

Split large file and save parts

BackgroundTask.splitFiles({
	files: [{
		fileSrc: "/file/to/split.mp4"
		filePartPath: "/path/to/save/part/"
		fileParthName: "FileName"
		fileParteSufix: "part" // create FileName.part
		filePartMaxSize: 3 // 3MB
	}],
	doneCallback: function(data){

		var files = []
		for(i in data){
			for(filePath in data[i].fileParts)
				files.push(it) // get name of parts
		}			
	},
	errorCallback: function(error){
		// error
	}
})