Titanium.Filesystem

module
0.2.0
A module for accessing the Filesystem.

Objects

AsyncCopy A representation of an asynchronous copy operation created via calling Filesystem.asyncCopy.
File An object which represents a path to a file or directory. A Filesystem.File is not guaranteed to be a valid path.
Filestream A object for reading and writing data to files.

Functions

asyncCopy Executes an asynchronous copy operation and returns an AsyncCopy object.
createTempDirectory Create a temporary directory. This directory is guaranteed to be writable. If it still exists when the application exits, it will be deleted.
createTempFile Create an temporary file. This file is guaranteed to be writable. If it still exists when the application exits, it will be deleted.
getApplicationDataDirectory Return the data directory of the application. The data directory is per-user directory for storing application data. It is guaranteed to be writable and stable between releases.
getApplicationDirectory Return the directory containing the application. The application directory may contain the application contents directory (OS X) or be the application contents directory (Windows and Linux). The application directory may not be writable and applications should not attempt to write to it.
getDesktopDirectory Return the Desktop directory for the current user. OS X and Windows will always have a valid Desktop directory. Some Linux systems may not have one, in which case the home directory will be returned.
getDocumentsDirectory Return the documents directory for the current user. OS X and Windows will always have a valid Documents directory. Some Linux systems may not have one, in which case the home directory will be returned.
getFile Create a Filesystem.File object given a variable-length argument list of Filesystem.File or a path strings. The list will be joined together to form one long path string.
getFileStream Create a Filesystem.Filestream object given a Filesystem.File or a path. Filesystem.Filestream is the preferred way of writing to files.
getLineEnding Return the line ending most commonly used by the current operating system. This is useful for writing files with the platform compatibility in mind. File.Filestream.writeLine will use this value when completing lines.
getProgramsDirectory Return the directory commonly used for storing applications on this platform. On Linux systems, there can be many places for storing executables, so it is not recommended using this value to locate them.
getResourcesDirectory Return the path to this application's resources directory. This diretory is the 'Resources' subdirectory of the application contents directory.
getRootDirectories Return the system root directories. On Unix systems there is at most one root directory '/' while on Windows active drive letters are considered system root directories.
getRuntimeHomeDirectory Return the directory of the current Titanium runtime files.
getSeparator Return the path separator used by the operating system.
getUserDirectory Return the home directory of the current user.

Properties

Type Name Description
Number MODE_APPEND A constant representing append mode for file access.
Number MODE_READ A constant representing read mode for file access.
Number MODE_WRITE A constant representing write mode for file access.