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 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
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.
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'));
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);
}
The name of the API that this proxy corresponds to.
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.
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
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
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.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
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.
A dictionary of properties to apply.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Returns the value of a property as a boolean data type.
Name of property.
Default value to return if property does not exist.
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.
Name of property.
Default value to return if property does not exist.
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.
Name of property.
Default value to return if property does not exist.
Returns the value of a property as an array data type.
Name of property.
Default value to return if property does not exist.
Returns the value of a property as an object.
Name of property.
Default value to return if property does not exist.
Returns the value of a property as a string data type.
Name of property.
Default value to return if property does not exist.
Indicates whether a property exists.
Name of property.
Returns an array of property names.
Removes all properties that have been set by the user on runtime, or does nothing otherwise.
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);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Removes a property if it exists, or does nothing otherwise.
Name of property.
Sets the value of a property as a boolean data type. The property will be created if it does not exist.
Name of property.
Property value.
Sets the value of the bubbleParent property.
New value for the property.
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.
Name of property.
Property value.
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.
Name of property.
Property value, within the range -2,147,483,648 to 2,147,483,647.
Sets the value of the lifecycleContainer property.
New value for the property.
Sets the value of a property as an array data type. The property will be created if it does not exist.
Name of property.
Property value.
Sets the value of a property as an object data type. The property will be created if it does not exist.
Name of property.
Property value.
Sets the value of a property as a string data type. The property will be created if it does not exist.
Name of property.
Property value.
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.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.