File

Required Phonegap plugins

cordova-plugin-file

API Documentation

Method Summary

writeToFile

Write to a file

Params

Type	Name	Summary	Required
String	fileName	fileName	Required
String	dir	cordova file dir (cordova.file*)	Required
Object	data	data to write to file	Required
Function	callbackSuccess	on success callback	Optional
Function	callbackError	on error callback	Optional

readFromFile

Read data from a file

Params

Type	Name	Summary	Required
String	fileName	fileName	Required
String	dir	cordova file dir (cordova.file*)	Required
Function	callbackSuccess	on success callback	Optional
Function	callbackError	on error callback	Optional

openfile

Open a file on device via native call

Params

Type	Name	Summary	Required
String	fileName	fileName	Required
String	fileType	file type of the content , example: 'application/pdf'	Required
String	dir	cordova file dir (cordova.file*)	Required
Function	cb	on success callback	Optional
Function	err	on error callback	Optionalc

Example Usage

/**
 * Saving some content to a file
 * @param {String} fileContent The content we want to save to a file
 * @properties={typeid:24,uuid:"3B68397E-9CCF-4111-8B5A-387B29062055"}
 */
function onAction$Save(fileName, fileContent) {
	//use default path for Android devices
	var dir = 'externalApplicationStorageDirectory';
	
	//if using an iPhone use a different path
	var isIOS = plugins.ngclientutils.getUserAgent().toLowerCase().indexOf('iphone');
	if (isIOS != -1) {
		dir = 'documentsDirectory';
	}
	
	//content is first converted from string to base64 using the built in utils method , then store the result to a file
	plugins.svyphonegapFile.writeToFile(fileName, dir, utils.stringToBase64(fileContent), writeSuccess, writeFail);
}

/**
 * Callback once the file finishes saving successfully
 * @properties={typeid:24,uuid:"F6685232-4CB6-44E8-A7D3-5F985E67382A"}
 */
function writeSuccess(e) {
	application.output('save successful')
	application.output(e) //debug messages
}

/**
 * Callback if file fails to save or write
 * @properties={typeid:24,uuid:"F6685232-4CB6-44E8-A7D3-5F985E67382A"}
 */
function writeFailure(e) {
	application.output('save failed')
	application.output(e) //debug messages
}

/**
 * Open a file natively on device
 * @properties={typeid:24,uuid:"21A0C180-DD35-4738-B813-CF296BE0EE3C"}
 */
function openPDFNativeHelper(){
	var dir = 'externalApplicationStorageDirectory';
	var isIOS = plugins.ngclientutils.getUserAgent().toLowerCase().indexOf('iphone');
	if (isIOS != -1) {
		dir = 'documentsDirectory';
	}
	//open a pdf via native application on device
	plugins.svyphonegapFile.openfile('example.pdf','application/pdf',dir,null,null);
}