# Titanium.Filesystem.FileStream

Wrapper around Titanium.Filesystem.File that implements the Titanium.IOStream interface

Availability

1.7

9.2.0

Extends

Titanium.IOStream

# Properties

# apiName READONLY

Availability

3.2.0

9.2.0

apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability

3.0.0

9.2.0

bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

# lifecycleContainer

Availability

3.6.0

lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

# Methods

# addEventListener

Availability

1.7

9.2.0

addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to invoke when the event is fired.

Returns

Type: void

# applyProperties

Availability

3.0.0

9.2.0

applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name	Type	Description
`props`	Dictionary	A dictionary of properties to apply.

Returns

Type: void

# close

Availability

1.7

9.2.0

close() → void

closes file stream, exception is thrown on error

Throws an exception on error.

Returns

Type: void

# fireEvent

Availability

1.7

9.2.0

fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`event`	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

Type: void

# isReadable

Availability

1.7

9.2.0

isReadable() → Boolean

Indicates whether this stream is readable.

Returns

True if stream is readable, false otherwise.

Type: Boolean

# isWritable

Availability

1.7

9.2.0

isWritable() → Boolean

Indicates whether this stream is writable.

Returns

True if stream is writable, false otherwise.

Type: Boolean

# read

Availability

1.7

9.2.0

read(buffer[, offset[, length[, resultsCallback]]]) → Number

Reads data from this stream into a buffer.

Takes an optional resultsCallback function as the last argument. If specified, the operation is done asynchronously. If no callback is passed in, the operation is done synchronously.

If offset and length are specified, data is written into the buffer starting at position offset. Data is read from this stream until one of the following occurs:

the end of this stream is reached
the end of the buffer is reached
a total of length bytes have been read from the stream

If offset and length are omitted, data is written starting at the beginning of the buffer.

When called synchronously: returns the number of bytes read, or -1 if the end of stream was reached before any data was read.

Returns 0 when called asynchronously.

Throws an exception on error. For example, if the offset value is past the last byte of buffer.

Parameters

Name	Type	Description
`buffer`	Titanium.Buffer	Buffer to read stream data into.
`offset`	Number	Offset into the buffer to start writing stream data. If specified, `length` must also be specified.
`length`	Number	Maximum number of bytes to read. If specified, `offset` must also be specified.
`resultsCallback`	Callback<ReadCallbackArgs>	Function to call with the results of the read operation.

Returns

Number of bytes read.

Type: Number

# removeEventListener

Availability

1.7

9.2.0

removeEventListener(name, callback) → void

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`.

Returns

Type: void

# write

Availability

1.7

9.2.0

write(buffer[, offset[, length[, resultsCallback]]]) → Number

Writes data from a buffer to this stream.

Takes an optional resultsCallback function as the last argument. If specified, the operation is done asynchronously. If no callback is passed in, the operation is done synchronously.

If offset and length are specified, data is read from the buffer starting at offset. Bytes are read from the buffer and written to the stream until:

the end of the buffer is reached
length bytes have been written
the stream returns an error

If offset and length are omitted, all of the data in the buffer is written to this stream.

Returns the number of bytes actually written when called synchronously.

Returns 0 when called asynchronously.

Throws an exception if an error is encountered.

Parameters

Name	Type	Description
`buffer`	Titanium.Buffer	Buffer to write to this stream.
`offset`	Number	Offset in the buffer of the first byte to write to the stream. If specified, `length` must also be specified.
`length`	Number	Maximum number of bytes to write to the stream. If specified, `offset` must also be specified.
`resultsCallback`	Callback<WriteCallbackArgs>	Function to call with the results of the write operation.

Returns

Number of bytes written.

Type: Number