Page Comparison

// Example to use telemetry SDK
telemetrySDK = TelemetrySDK.getInstance(this.manifest.id);

telemetrySDK.send({...});
telemetrySDK.send([{...}]);

telemetrySDK.sync();

getInstance = function(String pluginId) : FileSDK {};

mkdir

/* 
 * API to list the telemetry packets
 * @param status String - Get the packets based on the status
 * @return TelemetryPacket Document[]
 */
list = function(String pathstatus?) : PromiseTelemetryPacket[] {};

copy/* =
function(String source,* StringAPI dest)to :get Promisethe {};telemetry data mvfor =a function(String from, String to) : Promise {};

rm = function(String file) : Promise {};

rmdirgiven packet.
 * @param packetId String
 * @return TelemetryPacket Document
 */
get = function(String pathpacketId) : PromiseTelemetryPacket {};
 zip
=/* function(String
path, String* fileName)API :to Promise {};

unzip = function(String fileName, String path) : Promise {};

getAbsPathforce sync. This would create packets to be synced
 */
sync = function(String path) : StringPromise {};

watch/* =
function(String[] paths, callback){};

isNetworkAvailable = function() : boolean {};

// Events
// Following are the events fired within the SDK
network:available
network:disconnected

EventManager.on('network:available', function() {
	// Do something.
	// May be sync telemetry.
	// Fetch content updates
	// Resume content downloads
	// etc
});

/* Method to get the instance of the download manager */
getInstance

zip = function(String path, String fileName) : Promise {};

unzip = function(String pluginIdfileName, String path) : DownloadManagerPromise {};

/*getAbsPath = function(String *path) Method: toString queue{};
the
downloadwatch of a file
 * @Param file - The file to download
 * @Param path - Path to download the file
 * @return downloadId - The download id reference
 */
download = function(String file, String path) : String {};

/* 
 * Method to queue the download of a file
 * @Param file - The file to download
 * @Param path - Path to download the file
 * @return downloadId - The download id reference
 */
download = function(String[] files, String folder) : String {};

/* 
 * Method to get the status of the download
 * @Param downloadId String
 * @return Download object 
 */
get= function(String[] paths, callback){};

/* Method to get the instance of the settings sdk */
getInstance = function(String pluginId) : SettingsSDK {};

put: function(String key, Object value) : Promise {};

get: function(String key) : Promise {};

{
	document: {
		"_id"* Method to queue the download of a file
 * @param file - The file to download
 * @param path - Path to download the file
 * @return downloadId - The download id reference
 */
download = function(String[] files, String folder) : String {};

/* 
 * Method to get the status of the download
 * @param downloadId String
 * @return Download object 
 */
get = function(String downloadId) : DownloadObject {};

/* 
 * Method to pause the download
 * @param downloadId String
 */
pause = function(String downloadId) : Promise {};

/* 
 * Method to cancel the download
 * @param downloadId String
 */
cancel = function(String downloadId) : Promise {};

/* 
 * Method to pause all the downloads for the given plugin
 * @param downloadId String
 */
pauseAll = function() : Promise {};

/* 
 * Method to cancel all the downloads for the given plugin
 * @param downloadId String
 */
cancelAll = function() : Promise {};

/* 
 * Method to list the download queue based on the status
 * @param status String - The status of the download - Submitted, Complete, InProgress, Failed. Blank option will return all status
 * @return Array - Array of download objects
 */
list = function(String status): DownloadObject[] {};

DownloadObject = {
	id: String, // PluginDownload Idid
		"config"status: {}String, // PluginSubmitted, configInProgress, 	}Complete, 	index: []
}

{
	document: {
		"_id": String, // Setting id
		"value": Object // Setting value
	},
	index: []
}

{
	document: {
		"_id": String, // mid of the event
		"event": {} // event
	},
	index: []
}

{
	document: {
		"_id"Failed.
	createdOn: Date,
	updatedOn: Date,
  	stats: {
  		totalFiles: Number, // Total files to download
		downloadedFiles: Number, // Total files downloaded so far
  		totalSize: Number, // Total number of bytes to download
  		downloadedSize: Number, // Total number of bytes downloaded so far
  	},
  	files: [{ // Status of each file within the given download
  		file: String, // packetFile id
that is downloaded
  		"pluginId"source: String, // source from Pluginwhere idit theis packetdownloaded
belongs to 		"status"path: String, // Relative statuspath ofwhere the packet. Synced/NotSynced file is downloaded to
  		"createdOn"size: DateInteger, // Date of packet creation Total file size in bytes
  		"updatedOn"downloaded: Date,Integer // Downloaded Dateuntil now
when the document	}]
is}
updated
		"size": Number,
// EVENTS
// SizeFollowing ofare the events fired inwithin the packet
		"events": [] // events
	},
	index: [pluginId, status, updatedOn]
}

{
	document: {
		"_id"SDK
"<plugin>:download:complete"
EventManager.dispatch("sunbirded:download:complete", {
	id: String, // Download Id
	files: [{
		file: String, // File that Downloadis Iddownloaded
		"pluginId"source: String, // Pluginsource idfrom thewhere downloadit objectis belongsdownloaded
to
		statuspath: String, // Submitted,Relative InProgress,path Complete,where Failed.
		createdOn: Date,
		updatedOn: Date,
  		stats: {
  			totalFiles: Number,the file is downloaded to
		size: Integer // Totalfile filessize toin downloadbytes
			downloadedFiles: Number, // Total files downloaded so far
  			totalSize: Number, // Total number of bytes to download
  			downloadedSize: Number, // Total number of bytes downloaded so far
  		},
  		files: [{ // Status of each file within the given download
  			file: String, // File that is downloaded
  			source: String, // source from where it is downloaded
  			path: String, // Relative path where the file is downloaded to
  			size: Integer, // Total file size in bytes
  			downloaded: Integer // Downloaded until now
  		}]
	},
	index: [pluginId, status, updatedOn]
}

<app_base_dir>
	/logs
	|----/container.log
	|----/crash.log
	/<plugin_id>
	|----/files // Folder where the files are either download/imported
	|----/ecars // Folder where the ecar files are stored
	|----/logs // Plugin logs
	|--------/application.log
	|--------/crash.log
	|----/content
	|--------/<do_xxxxxx> // Path where the ecar files are extracted and served via http during play