# Titanium.App.Properties

The App Properties module is used for storing application-related data in property/value pairs that persist beyond application sessions and device power cycles.

Availability
0.8
0.8
9.2.0
4.1.0

# Overview

# App Properties in the tiapp.xml file

App properties defined in the tiapp.xml file may be accessed using these APIs. An app property is defined inside the root-level <ti:app> element with the <property> element. Use the name attribute to define your property name and place the value inline with the <property> element. For example, to define an app property called foo with the value 42:

<?xml version="1.0" encoding="UTF-8"?>
<ti:app xmlns:ti="http://ti.appcelerator.org">
    <property name="foo" type="string">42</property>
</ti:app>

Then, you can retrieve the property during runtime with the following API call:

var foo = Ti.App.Properties.getString('foo');

As of Release 3.2.0, any application properties defined in the tiapp.xml file are stored in the device's secure storage, making them read-only. Additionally, external access to these properties is now restricted. Other iOS applications cannot access these properties and native Android modules must use the Titanium module API TiApplication.getAppProperties (opens new window) method to access these properties.

If you need to change the values during runtime, initially create the property with these APIs rather than defining them in the tiapp.xml file.

Prior to Release 3.2.0, application properties defined in the tiapp.xml file could be overwritten by these APIs and accessed externally by other applications and modules.

# Examples

# Store a property

Store a string property.

Ti.App.Properties.setString('givenName', 'Paul');
Ti.API.info('The value of the givenName property is: ' + Ti.App.Properties.getString('givenName'));

# Enumerate over saved properties

Output all saved properties to the console.

var props = Ti.App.Properties.listProperties();

for (var i = 0, ilen = props.length; i < ilen; i++){
    var value = Ti.App.Properties.getString(props[i]);
    Ti.API.info(props[i] + ' = ' + value);
}

# Methods

# getBool

Availability
0.8
0.8
9.2.0
4.1.0
getBool(property[, default]) Boolean

Returns the value of a property as a boolean data type.

Parameters

Name Type Description
property String

Name of property.

default Boolean

Default value to return if property does not exist.

Returns

Type
Boolean

# getDouble

Availability
0.8
0.8
9.2.0
4.1.0
getDouble(property[, default]) Number

Returns the value of a property as a double (double-precision, floating point) data type.

This method must only be used to retrieve properties created with setDouble.

Parameters

Name Type Description
property String

Name of property.

default Number

Default value to return if property does not exist.

Returns

Type
Number

# getInt

Availability
0.8
0.8
9.2.0
4.1.0
getInt(property[, default]) Number

Returns the value of a property as an integer data type.

This method must only be used to retrieve properties created with setInt.

Use getDouble and setDouble to store values outside the integer data type range of -2,147,483,648 to 2,147,483,647.

Parameters

Name Type Description
property String

Name of property.

default Number

Default value to return if property does not exist.

Returns

Type
Number

# getList

Availability
0.8
0.8
9.2.0
4.1.0
getList(property[, default]) Array<Object>

Returns the value of a property as an array data type.

Parameters

Name Type Description
property String

Name of property.

default Array<Object>

Default value to return if property does not exist.

Returns

Type
Array<Object>

# getObject

Availability
0.8
0.8
9.2.0
4.1.0
getObject(property[, default]) Object

Returns the value of a property as an object.

Parameters

Name Type Description
property String

Name of property.

default Object

Default value to return if property does not exist.

Returns

Type
Object

# getString

Availability
0.8
0.8
9.2.0
4.1.0
getString(property[, default]) String

Returns the value of a property as a string data type.

Parameters

Name Type Description
property String

Name of property.

default String

Default value to return if property does not exist.

Returns

Type
String

# hasProperty

Availability
0.8
0.8
9.2.0
4.1.0
hasProperty(property) Boolean

Indicates whether a property exists.

Parameters

Name Type Description
property String

Name of property.

Returns

Type
Boolean

# listProperties

Availability
0.8
0.8
9.2.0
4.1.0
listProperties() Array<Object>

Returns an array of property names.

Returns

Type
Array<Object>

# removeAllProperties

Availability
6.0.0
6.0.0
9.2.0
6.0.0
removeAllProperties() void

Removes all properties that have been set by the user on runtime, or does nothing otherwise.

Returns

Type
void

# removeProperty

Availability
0.8
0.8
9.2.0
4.1.0
removeProperty(property) void

Removes a property if it exists, or does nothing otherwise.

Parameters

Name Type Description
property String

Name of property.

Returns

Type
void

# setBool

Availability
0.8
0.8
9.2.0
4.1.0
setBool(property, value) void

Sets the value of a property as a boolean data type. The property will be created if it does not exist.

Parameters

Name Type Description
property String

Name of property.

value Boolean

Property value.

Returns

Type
void

# setDouble

Availability
0.8
0.8
9.2.0
4.1.0
setDouble(property, value) void

Sets the value of a property as a double (double-precision, floating point) data type. The property will be created if it does not exist.

Parameters

Name Type Description
property String

Name of property.

value Number

Property value.

Returns

Type
void

# setInt

Availability
0.8
0.8
9.2.0
4.1.0
setInt(property, value) void

Sets the value of a property as an integer data type. The property will be created if it does not exist.

Use getDouble and setDouble to store values outside the integer data type range of -2,147,483,648 to 2,147,483,647.

Parameters

Name Type Description
property String

Name of property.

value Number

Property value, within the range -2,147,483,648 to 2,147,483,647.

Returns

Type
void

# setList

Availability
0.8
0.8
9.2.0
4.1.0
setList(property, value) void

Sets the value of a property as an array data type. The property will be created if it does not exist.

Parameters

Name Type Description
property String

Name of property.

value Array<Object>

Property value.

Returns

Type
void

# setObject

Availability
0.8
0.8
9.2.0
4.1.0
setObject(property, value) void

Sets the value of a property as an object data type. The property will be created if it does not exist.

Parameters

Name Type Description
property String

Name of property.

value Object

Property value.

Returns

Type
void

# setString

Availability
0.8
0.8
9.2.0
4.1.0
setString(property, value) void

Sets the value of a property as a string data type. The property will be created if it does not exist.

Parameters

Name Type Description
property String

Name of property.

value String

Property value.

Returns

Type
void

# Events

# change

Availability
3.0.0
9.2.0

Fired when a property is changed.

On iOS, the event is fired when the user re-enters the application after making a change using the Settings application.

The event is also fired when the application changes a property directly using one of the Ti.App.iOS.UserDefaults or Ti.App.Properties methods.