File Archiving

You can manage ZIP archives and operate on the archived files.

The Archive API is mandatory for Tizen Mobile, Wearable, and TV profiles, which means that it is supported on all mobile, wearable, and TV devices. All mandatory APIs are supported on the Tizen emulators.

The main features of the Archive API include the following:

• Accessing archive content

  You can read the content of an archive file.

• Creating new archives

  You can create archive files and add files into them.

• Extracting archived files

  You can extract a single file or all files from an archive file.

• Aborting operations

  You can abort an on-going archive operation.

To start any kind of ZIP operation (packing or unpacking), you must first call the open() method of the ArchiveManager interface (in mobile, wearable, and TV applications). The first parameter is a FileReference object (in mobile, wearable, and TV applications), which can be a File object (in mobile, wearable, and TV applications) or the virtual path. The second parameter is a FileMode enumerator (in mobile, wearable, and TV applications), whose values are described in the following table.

Table: File modes

Prerequisites

To use the Archive API (in mobile, wearable, and TV applications), the application has to request permission by adding the following privileges to the config.xml file:

<tizen:privilege name="http://tizen.org/privilege/filesystem.read"/>
<tizen:privilege name="http://tizen.org/privilege/filesystem.write"/>

Read the content of an archive

Opening an archive and accessing a list of its members is a basic archive management skill:

1. To access the archive file, use the open() method of the ArchiveManager interface (in mobile, wearable, and TV applications). The provided callback receives an ArchiveFile object (in mobile, wearable, and TV applications):

   var myArchive = null;
   function openSuccess(arch) {
       console.log('ArchiveFile mode: ' + arch.mode);
       myArchive = arch;
   }
   tizen.archive.open('downloads/archive.zip', 'r', openSuccess);
   

2. Get the list of all files contained inside the archive using the getEntries() method of the ArchiveFile interface:

   function listSuccess(members) {
       if (members.length === 0) {
           console.log('The archive is empty');
   
           return;
       }
       console.log('Files in the archive:')
       for (var i = 0; i < members.length; i++) {
           console.log(members[i].name);
       }
   }
   myArchive.getEntries(listSuccess);
   

3. After the work with the archive is finished, close the archive using the close() method of the ArchiveFile interface:

   archive.close();
   

Create an archive

Creating an archive and adding files to it is a basic archive management skill:

1. To create the archive file, use the open() method of the ArchiveManager interface (in mobile, wearable, and TV applications) and set the mode as w:

   tizen.archive.open('downloads/new_archive.zip', 'w', createSuccess);
   

2. Add a file to the archive using the add() method. The file can be specified using a virtual path:

   function progressCallback(opId, val, name) {
       console.log('opId: ' + opId + ' with progress val: ' + (val * 100).toFixed(0) + '%');
   }
   function successCallback() {
       console.log('File added');
   }
   function createSuccess(archive) {
       archive.add('downloads/file.txt', successCallback, null, progressCallback);
   }
   

Extract files from an archive

Extracting a file from an archive is a basic archive management skill:

1. To access an archive file, use the open() method of the ArchiveManager interface (in mobile, wearable, and TV applications). The “r” mode is suitable for extracting from the archive:

   tizen.archive.open('downloads/some_archive.zip', 'r', openSuccess, openError);
   

2. To extract files:

   • To extract all files from the archive, use the extractAll() method of the ArchiveFile interface (in mobile, wearable, and TV applications):

     function progressCallback(opId, val, name) {
         console.log('extracting operation (: ' + opId + ') is in progress (' + (val * 100).toFixed(1) + '%)');
     }
     
     function openSuccess(archive) {
         archive.extractAll('music', null, null, progressCallback);
     }
     

   • To extract only a selected file from the archive, use the extract() method of the ArchiveFileEntry interface (in mobile, wearable, and TV applications).

     First, get the archiveFileEntry object using the getEntryByName() or getEntries() method of the ArchiveFile interface:

     function extractSuccessCallback() {
         console.log('File extracted');
     }
     function getEntrySuccess(entry) {
         entry.extract('downloads/extract', extractSuccessCallback);
     }
     
     function openSuccess(archive) {
         archive.getEntryByName('my_file.txt', getEntrySuccess);
     }
     

Abort file operations

You can abort an on-going file archive operation for the open(), add(), extractAll(), getEntries(), getEntryByName(), and extract() methods.

To abort the file archive operation, use the operation ID and the abort() method of the ArchiveManager interface (in mobile, wearable, and TV applications):

function openSuccess(archive) {
    operationId = archive.extractAll('downloads/extracted');
    tizen.archive.abort(operationId);
}

tizen.archive.open('downloads/some_archive.zip', 'r', openSuccess);

Related information

• Dependencies
  • Tizen 2.4 and Higher for Mobile
  • Tizen 2.3.1 and Higher for Wearable
  • Tizen 3.0 and Higher for TV