# 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

9.2.0

Extends

Titanium.Module

# 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.tidev.io">
    <property name="foo" type="string">42</property>
</ti:app>

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

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

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() 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.

Important: Using this API in the Apple ecosystem requires the NSPrivacyAccessedAPICategoryUserDefaults property set in the privacy manifest that was introduced in iOS 17. You can learn more about it here (opens new window).

# 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);
}

# 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

0.8

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

# fireEvent

Availability

0.8

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

# getBool

Availability

0.8

9.2.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

9.2.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

9.2.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

9.2.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

9.2.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

9.2.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

9.2.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

9.2.0

listProperties() → Array<Object>

Returns an array of property names.

Returns

Type: Array<Object>

# removeAllProperties

Availability

6.0.0

9.2.0

removeAllProperties() → void

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

Returns

Type: void

# removeEventListener

Availability

0.8

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

# removeProperty

Availability

0.8

9.2.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

9.2.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

9.2.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

9.2.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

9.2.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

9.2.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

9.2.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.