The application's resource directory.

The url property for this object uses the app-resource URL scheme (not the file URL scheme). This means that the url string is specified starting with "app-resource:" (not file:). Also, if you create a File object relative to the appResourceDirectory directory (using the resolve() method), the url of the File object also uses the app-resource URL scheme.

The application's private storage directory. Each Apollo application has a unique, persistent application storage directory, which is created when you first access appStorageDirectory. This directory is a convenient location to store application-specific data.

The url property for this object uses the app-storage URL scheme (not the file URL scheme). This means that the url string is specified starting with "app-storage:" (not file:). Also, if you create a File object relative to the applicationStoreDirectory directory (using the resolve() method), the url of the File object also uses the app-storage URL scheme (as in the example).

The "current directory" at the time the application was launched.

Note: Use the currentDirectory property of the invoke event dispatched by the Shell object to resolve the relative paths provided in any command-line parameters provided when the file is launched. Do not use the File.currentDirectory property.

See also

import flash.filesystem.File;
trace(File.currentDirectory.nativePath);

The user's desktop directory.

import flash.filesystem.File;
var desktop:File = File.desktopDirectory;

var files:Array = desktop.listDirectory()

for (var i:uint = 0; i < files.length; i++) {
    trace(files[i].nativePath)
}

The user's documents directory.

On Windows, this is the "My Documents" directory (for example, C:\Documents and Settings\userName\My Documents). On Mac OS, it is /Users/userName/Documents.

import flash.filesystem.File;

var directory:File = File.documentsDirectory;
directory = directory.resolve("Apollo Test");

File.createDirectory(directory);
trace(directory.exists); // true

Checks whether referenced file or directory exists.

import flash.filesystem.*;

var temp:File = File.createTempFile();
trace(temp.exists) // true
temp.deleteFile();
trace(temp.exists) // false

Checks whether the reference is to a directory.

import flash.filesystem.*;

var userDirFiles:Array = File.userDirectory.listDirectory();
for (var i:uint = 0; i < userDirFiles.length; i++) {
    if (userDirFiles[i].isDirectory) {
        trace(userDirFiles[i].nativePath);
    }
}

Checks whether the referenced file or directory is "hidden."

import flash.filesystem.*;

var userDirFiles:Array = File.userDirectory.listDirectory();
for (var i:uint = 0; i < userDirFiles.length; i++) {
    if (userDirFiles[i].isHidden) {
        trace(userDirFiles[i].nativePath);
    }
}

The line-ending character sequence used by the host operating system.

On Mac OS, this is the line-feed character (character code 0x0A hexadecimal). On Windows, this is the carriage return character (character code 0x0D hexadecimal) followed by the line-feed character (character code 0x0A hexadecimal).

import flash.filesystem.*;

var str:String = "Hello\n" + 
        "World\n";
str = str.replace(/\n/g, File.lineEnding);
var file:File = File.documentsDirectory.resolve("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.open(file, FileMode.WRITE);
fileStream.writeUTF(str);
fileStream.close();

The full path in the host operating system representation. On Mac OS, the forward slash (/) character is used as the path separator. However, in Windows, you can set the nativePath property using the forward slash (/) character or the backslash (\) character as the path separator, and Apollo automatically replaces forward slashes with the appropriate backslash (\) character.

import flash.filesystem.File;

var docs:File = File.documentsDirectory;
trace(docs.nativePath); // C:\Documents and Settings\turing\My Documents
trace(docs.url); // file:///C:/Documents%20and%20Settings/turing/My%20Documents

The parent of this File reference.

This property is identical to the return value for resolve("..") except that the parent of a root directory is null.

import flash.filesystem.File;

var tempFile:File = File.createTempDirectory();
trace(tempFile.parent.nativePath);
tempFile.deleteFile();

The host operating system's path component separator character.

On Mac OS, this is the forward slash (/) character. On Windows, it is the backslash (\ character.

Note: When using the backslash character in a String literal, remember to type the character twice (as in "directory\\file.ext"). Each pair of backslashes in a String literal represent a single backslash in the String.

import flash.filesystem.File;

var directory:File = File.documentsDirectory.resolve("Apollo Test");
var file:File = File.documentsDirectory.resolve("Apollo Test/employees/bob/test.txt");

var relativePath:String = directory.relativize(file); // employees/bob/test.txt
relativePath = relativePath.replace(/\//g, File.separator);
trace(relativePath); 

The default encoding used by the host operating system. Possible values include "windows-1252" "shift-jis", "cn-gb", "iso-8859-1", and others. For a complete list, see Supported Character Sets.

You may use this value when using the readMultiByte() and writeMultiByte() methods of the FileStream class.

See also

import flash.filesystem.File;

var file:File = File.documentsDirectory.resolve("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.open(file, FileMode.READ);
var str:String = fileStream.readMultiByte(file.size, File.systemCharset);
trace(str);

The URL for this File path.

If this is a reference to the persistent store, the URL scheme is "app-storage", otherwise the scheme is "file".

You can use blank space characters (rather than "%20") when assigning a value to the url property, and Apollo automatically encodes the strings (for instance, converting spaces to "%20").

See also

import flash.filesystem.File;

var docs:File = File.documentsDirectory;
trace(docs.nativePath); // C:\Documents and Settings\turing\My Documents
trace(docs.url); // file:///C:/Documents%20and%20Settings/turing/My%20Documents

The user's directory.

On Windows, this is the parent of the "My Documents" directory (for example, C:\Documents and Settings\userName). On Mac OS it is /Users/userName.

import flash.filesystem.File;

var files:Array = File.userDirectory.listDirectory()
for (var i:uint = 0; i < files.length; i++) {
    trace(files[i].nativePath)
}

The constructor function for the File class. If you pass a path argument, the File object points to the specified path, and the nativePath property and and url property are set to reflect that path.

See also

Cancels any pending asynchronous operation.

Canonicalizes the File path.

If the File object represents an existing file or directory, canonicalization adjusts the path so that it matches the case of the actual file or directory name.

In addition, canonicalization converts short files names to long file names on Windows.

import flash.filesystem.*;

var path:File = File.desktopDirectory.resolve("apollo test");
trace(path.nativePath); 
path.canonicalize();
trace(path.nativePath); // ...\Apollo Test

import flash.filesystem.*;

var path:File = new File();
path.nativePath = "C:\\APOLLO~1";
path.canonicalize();
trace(path.nativePath); // C:\Apollo Test

Returns a copy of this File object. Event registrations are not copied.

Note: This method does not copy the file itself. It simply makes a copy of the instance of the ActionScript File object. To copy a file, use the copyTo() method.

Copies the file or directory at the location specified by this File object to the location specified by newLocation parameter.

See also

import flash.filesystem.File;
import flash.events.Event;

var sourceFile:FileReference = File.documentsDirectory;
sourceFile = sourceFile.resolve("Apollo Test/test1.txt");
var destination:FileReference = File.documentsDirectory;
destination = destination.resolve("Apollo Test/test2.txt");

if (sourceFile.copyTo(destination, true)) {
    trace("Done.")
}

import flash.filesystem.File;

var sourceFile:File = File.documentsDirectory;
sourceFile = sourceFile.resolve("Apollo Test/test1.txt");
var destination:File = File.documentsDirectory;
destination = destination.resolve("Apollo Test/test2.txt");

try 
{
    if (sourceFile.copyTo(destination, true)) {
}
catch (error:Error)
{
    trace("Error:" error.message)
}

Begins copying the file or directory at the location specified by this File object to the location specified by the destination parameter. Upon completion, either a complete event (successful) or an ioError event (unsucessful) is dispatched.

See also

import flash.filesystem.File;
import flash.events.Event;

var sourceFile:File = File.documentsDirectory;
sourceFile = sourceFile.resolve("Apollo Test/test1.txt");
var destination:File = File.documentsDirectory;
destination = destination.resolve("Apollo Test/test2.txt");

var sourceFile.copyToAsync(destination, true);
sourceFile.addEventListener(Event.COMPLETE, fileCopiedHandler);

function fileCopiedHandler(event:Event): void {
    trace("Done.")
}

Creates the specified directory and any necessary parent directories. If the directory already exists, no action is taken.

import flash.filesystem.*;

var source:File = File.desktopDirectory.resolve("test.txt");
var target:File = File.documentsDirectory.resolve("Apollo Test/test.txt");
var targetParent:File = target.parent;
targetParent.createDirectory();
source.moveTo(target, true);

Returns a reference to a new temporary directory. This is a new directory in the system's temporary directory path.

This method lets you identify a new, unique directory, without having to query the system to see that the directory is new and unique.

See also

Returns a reference to a new temporary file. This is a new file in the system's temporary directory path.

This method lets you identify a new, unique file, without having to query the system to see that the file is new and unique.

See also

Deletes the directory.

See also

import flash.filesystem.File;

var directory:File = File.documentsDirectory.resolve("Empty Junk Directory/");
File.createDirectory(directory);
trace(directory.exists); // true
directory.deleteDirectory();
trace(directory.exists); // false

Deletes the directory asynchronously.

See also

Deletes the file.

See also

import flash.filesystem.*;

var file:File = File.createTempFile();
trace(file.exists); // true
file.deleteFile();
trace(file.exists); // false

Deletes the file asynchronously.

See also

Returns an array of File objects corresponding to files and directories in the directory represented by this File object. This method does not explore the contents of subdirectories.

See also

import flash.filesystem.File;

var directory:File = File.userDirectory;
var list:Array = directory.listDirectory();
for (var i:uint = 0; i < list.length; i++) {
    trace(list[i].nativePath);
}

Asynchronously retrieves an array of File objects corresponding to the contents of the directory represented by this File object.

See also

import flash.filesystem.File;
import flash.events.FileListEvent;

var directory:File = File.userDirectory;
directory.listDirectoryAsync();
directory.addEventListener(FileListEvent.DIRECTORY_LISTING, directoryListingHandler);

function directoryListingHandler(event:FileListEvent):void {
    var list:Array = event.files;
    for (var i:uint = 0; i < list.length; i++) {
        trace(list[i].nativePath);
    }
}

Returns an array of file system root directories.

Moves the file or directory at the location specified by this File object to the location specified by the destination parameter.

To rename a file, set the destination parameter to point to a path that is in the file's directory, but with a different filename

See also

import flash.filesystem.File;
import flash.events.Event;

var sourceFile:File = File.documentsDirectory;
sourceFile = sourceFile.resolve("Apollo Test/test1.txt");
var destination:File = File.documentsDirectory;
destination = destination.resolve("Apollo Test/test2.txt");

try  
{
    sourceFile.moveTo(destination, true);
}
catch (error:Error)
{
    trace("Error:" error.message);
}

import flash.filesystem.File;

var sourceFile:File = File.documentsDirectory;
sourceFile = sourceFile.resolve("Apollo Test/test1.txt");
var destination:File = File.documentsDirectory;
destination = destination.resolve("Apollo Test/Results/test1.txt");

try 
{
    sourceFile.moveTo(destination, true);
}
catch (error:Error)
{
    trace("Error:" error.message);
}

Begins moving the file or directory at the location specified by this File object to the location specified by the newLocation parameter.

To rename a file, set the destination parameter to point to a path that is in the file's directory, but with a different filename

See also

import flash.filesystem.File;
import flash.events.Event;

var sourceFile:File = File.documentsDirectory;
sourceFile = sourceFile.resolve("Apollo Test/test1.txt");
var destination:File = File.documentsDirectory;
destination = destination.resolve("Apollo Test/test2.txt");

var sourceFile.moveToAsync(destination, true);
sourceFile.addEventListener(Event.COMPLETE, fileMoveCompleteHandler);

function fileMoveCompleteHandler(event:Event): void 
{
    trace("Done.")
}

Moves a file or directory to the trash.

See also

Asynchronously moves a file or directory to the Trash.

See also

Finds relative path between two File paths.

The relative path is the list of components which may be appended to (resolved against) this reference in order to locate the second (parameter) reference. The relative path is returned using the "/" separator character.

Optionally, relative paths may include ".." references, but such a paths will not cross conspicuous volume boundaries.

import flash.filesystem.File;

var file1:File = File.documentsDirectory.resolve("Apollo Test");
var file2:File = File.documentsDirectory.resolve("Apollo Test/bob/test.txt");

trace(file1.relativize(file2));       //   bob/test.txt
trace(file2.relativize(file1));       //   null
trace(file2.relativize(file1, true)); //   ../..

Creates a new File object with a path relative to this this File object's path, based on the path parameter (a String).

If the given path is an absolute file reference, then that path is used, otherwise the path is interpreted relative to this File object as follows.

The given path is "appended" to this path (however, use of ".." in the path can return a resulting path that is not a child of the File object). The resulting reference need not refer to an actual file system location. Use the forward slash (/) character as the path separator (not \).

All resulting paths are normalized as follows:

• Any "." element is ignored.
• Any ".." element consumes its parent entry.
• No ".." reference reaching the file system root or the application-persistent storage root will pass that node; it will be ignored.

Dispatched when a pending asynchronous operation is canceled.

Defines the value of the type property of a cancel event object.

This event has the following properties:

Dispatched when an asynchronous operation is complete.

Defines the value of the type property of a complete event object.

This event has the following properties:

Dispatched when a directory list is available as a result to a call to the listDirectoryAsync() method.

See also

Dispatched when an error occurs during an asynchronous file operation.

Defines the value of the type property of an ioError event object.

This event has the following properties:

Dispatched when a an operation violates a security constraint.

The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object.

This event has the following properties:

Dispatched when the user selects a file or directory from the a file- or directory-browsing dialog box.

Defines the value of the type property of a select event object.

This event has the following properties: