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.

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.

Extends: Titanium.Module · Since: 0.5

Properties #

apiName#

extended

Type: 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, Button
returns Ti.UI.Button.

bubbleParent#

extended

Type: 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.

lifecycleContainer#

extended

Type: 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 #

extended

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

Parameters:

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

applyProperties #

extended

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	Summary	Optional
`props`	`Dictionary`	A dictionary of properties to apply.	No

fireEvent #

extended

Fires a synthesized event to any registered listeners.

Parameters:

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

getBool #

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

Parameters:

Name	Type	Summary	Optional
`property`	`String`	Name of property.	No
`default`	`Boolean`	Default value to return if property does not exist.	Yes

Returns: Boolean

getDouble #

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	Summary	Optional
`property`	`String`	Name of property.	No
`default`	`Number`	Default value to return if property does not exist.	Yes

Returns: Number

getInt #

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	Summary	Optional
`property`	`String`	Name of property.	No
`default`	`Number`	Default value to return if property does not exist.	Yes

Returns: Number

getList #

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

Parameters:

Name	Type	Summary	Optional
`property`	`String`	Name of property.	No
`default`	`Array<Object>`	Default value to return if property does not exist.	Yes

Returns: Array<Object>

getObject #

Returns the value of a property as an object.

Parameters:

Name	Type	Summary	Optional
`property`	`String`	Name of property.	No
`default`	`Object`	Default value to return if property does not exist.	Yes

Returns: Object

getString #

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

Parameters:

Name	Type	Summary	Optional
`property`	`String`	Name of property.	No
`default`	`String`	Default value to return if property does not exist.	Yes

Returns: String

hasProperty #

Indicates whether a property exists.

Parameters:

Name	Type	Summary	Optional
`property`	`String`	Name of property.	No

Returns: Boolean

listProperties #

Returns an array of property names.

Returns: Array<Object>

removeAllProperties #

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

removeEventListener #

extended

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	Summary	Optional
`name`	`String`	Name of the event.	No
`callback`	`Callback<Titanium.Event>`	Callback function to remove. Must be the same function passed to `addEventListener`.	No

removeProperty #

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

Parameters:

Name	Type	Summary	Optional
`property`	`String`	Name of property.	No

setBool #

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

Parameters:

Name	Type	Summary	Optional
`property`	`String`	Name of property.	No
`value`	`Boolean`	Property value.	No

setDouble #

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	Summary	Optional
`property`	`String`	Name of property.	No
`value`	`Number`	Property value.	No

setInt #

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	Summary	Optional
`property`	`String`	Name of property.	No
`value`	`Number`	Property value, within the range `-2,147,483,648` to `2,147,483,647`.	No

setList #

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

Parameters:

Name	Type	Summary	Optional
`property`	`String`	Name of property.	No
`value`	`Array<Object>`	Property value.	No

setObject #

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

Parameters:

Name	Type	Summary	Optional
`property`	`String`	Name of property.	No
`value`	`Object`	Property value.	No

setString #

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

Parameters:

Name	Type	Summary	Optional
`property`	`String`	Name of property.	No
`value`	`String`	Property value.	No

Events #

change #

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.

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

Notificationchannels

Launchoptionstype

Notificationparams

Usernotificationattachment

Usernotificationsettings

Mediascannerresponse

Clipboarditemstype

Systemimageparameters

Titanium.App.Properties ​

App Properties in the tiapp.xml file ​

Properties #

apiName#

bubbleParent#

lifecycleContainer#

Methods #

addEventListener #

applyProperties #

fireEvent #

getBool #

getDouble #

getInt #

getList #

getObject #

getString #

hasProperty #

listProperties #

removeAllProperties #

removeEventListener #

removeProperty #

setBool #

setDouble #

setInt #

setList #

setObject #

setString #

Events #

change #

Examples #

Store a property

Enumerate over saved properties

Titanium.App.Properties

App Properties in the tiapp.xml file