Titanium SDK

# Titanium.App.iOS.UserDefaults

The UserDefaults module is used for storing application-related data in property/value pairs that persist beyond application sessions and device power cycles. UserDefaults allows the suiteName of the UserDefaults to be specified at creation time.

Important: Using this API requires the NSPrivacyAccessedAPICategoryUserDefaults property set in the privacy manifest that was introduced in iOS 17. You can learn more about it here.

Availability
4.0.0
9.2.0
Extends
Titanium.App.Properties

# Overview

Unlike Titanium.App.Properties, Titanium.App.iOS.UserDefaults does not pull properties defined in the tiapp.xml file.

To create a UserDefaults object, use the Titanium.App.iOS.createUserDefaults method.

# Examples

# Create a UserDefaults object

Creating a UserDefaults object

var props = Ti.App.iOS.createUserDefaults({
    suiteName: 'group.mySuite'
});

# Properties

# apiName READONLY

Availability
4.0.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
4.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

# suiteName CREATION ONLY

Availability
4.0.0
9.2.0
suiteName :String

Sets the name of the suite to be used to access UserDefaults.

# Methods

# addEventListener

Availability
4.0.0
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
4.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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.0.0
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
4.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.

Contents