File

API Summary

copy

Supported Platform(s)

Description

Copy a file to a given destination.

deleteFile

Supported Platform(s)

Description

Delete a given file.

exists

Supported Platform(s)

Description

Check whether or not a given file exists.

getFileProperties

Supported Platform(s)

Description

Get the FileProperties object for a given file.

open

Supported Platform(s)

Description

Open the specified file with the registered content handler.

readFile

Supported Platform(s)

Description

Reads in a file from the local file system.

rename

Supported Platform(s)

Description

Rename a given file.

saveFile

Supported Platform(s)

Description

Save a Blob to the local file system.

Code Example(s)

<script type="text/javascript">
  var xmlString = "<test>IO functions</test>";
  var filePath = "file:///store/home/user/sample.xml";
  var parser = new DOMParser();
  var doc = parser.parseFromString(xmlString, "text/xml");
  var blob_data = blackberry.utils.documentToBlob(doc);
     
  blackberry.io.file.saveFile(filePath, blob_data);
                
  if (blackberry.io.file.exists(filePath)) {
    blackberry.io.file.copy(filePath, "file:///SDCard/myxmlfile2.xml");
    blackberry.io.file.readFile(filePath,handleOpenedFile);
  }
     
  function handleOpenedFile(fullPath, blobData) {
    alert("file opened was: " + fullPath + " which contained " + blobData.length + " bytes");
  }
</script>

http://localhost:8472/blackberry/io/file/copy

Supported Platform(s)

Description

Copy a file to a given destination.

Returns

{
  "data" : {
    "path" : "<path that was passed>",
    "targetPath" : "<targetPath that was passed>"
  }
}

http://localhost:8472/blackberry/io/file/delete

Supported Platform(s)

Description

Delete the specified file.

Returns

{
  "data" : {
    "path" : "<path that was passed>"
  }
}

http://localhost:8472/blackberry/io/file/exists

Supported Platform(s)

Description

Determine whether a given file exists or not.

Returns

{
  "data" : {
    "path": "<path that was passed>",
    "exists" : true if the path exists and points to a file, false otherwise
  }
}

http://localhost:8472/blackberry/io/file/get

Supported Platform(s)

Description

Get properties for a given file.

Returns

{
  "data" : {
    "path" : "<path that was passed>",
    "dateCreated" : "<file creation date, in number of milliseconds since UTC>", // only defined if "code" is 0
    "dateModified" : "<file modification date, in number of milliseconds since UTC>", // only defined if "code" is 0
    "directory" : "<path of directory that contains this file>", // only defined if "code" is 0
    "fileExtension" : "<file extension>", // only defined if "code" is 0
    "isHidden" : true (if file is hidden) or false (if file is not hidden), // only defined if "code" is 0
    "size" : <file size in bytes> // only defined if "code" is 0
  }
}

Code Example(s)

<script type="text/javascript" src="js/jquery-1.4.2.js"></script>
<script type="text/javascript">
  var filePath = encodeURI(blackberry.io.dir.appDirs.app.storage.path + '/myfile.txt'); 
  var reviverFn = function(key, value) {
     // construct JS Date object from number of milliseconds since UTC
     if (key.toLowerCase().indexOf('date') != -1) {
        return new Date(value);
     } else {
        return value;
     }
  };

  // inspect properties for this file
  $.ajax({
     url: "http://localhost:8472/blackberry/io/file/get?path=" + filePath,
     success: function(result, textStatus, jqXHR){
       try {
          var resultObj = JSON.parse(result, reviverFn);
          alert("code=" + resultObj.code + " msg=" + resultObj.msg);

          for (var f in resultObj.data) {
             alert(f + ':' + resultObj.data[f]);
          }
       } catch (e) {
          alert('e.message = ' + e.message);
       }                
     }
  });
</script>

http://localhost:8472/blackberry/io/file/open

Supported Platform(s)

Description

Open the specified file with the registered content handler.

Returns

{
  "data" : {
    "path" : "<path that was passed>"
  }
}

http://localhost:8472/blackberry/io/file/rename

Supported Platform(s)

Description

Rename a given file.

Returns

{
  "data" : {
    "path" : "<path that was passed>",
    "newFileName" : "<newFileName that was passed>"
  }
}