Titanium

The top-level Titanium module.

The Titanium module provides the Titanium Mobile API, allowing developers to access native features of each target environment. Currently, the Android and iOSenvironments are supported.

Titanium Namespace

The complete Titanium API is accessible from the Titanium namespace but, for convenience and brevity, the alias Ti is also provided. As the Titanium namespace is functionally-identical to its Ti alias, it is always recommended to use Ti in your code.

For example, the following pairs of Titanium calls behave exactly the same.

Titanium.API.info('Hello Titanium!');
Ti.API.info('Hello Titanium!');

Titanium.Utils.sha256('Hello Titanium!');
Ti.Utils.sha256('Hello Titanium!');

Titanium.App.Properties.setString('hello_msg','Hello Titanium!');
Ti.App.Properties.setString('hello_msg','Hello Titanium!');

Titanium.Database.open('mydb');
Ti.Database.open('mydb');

Global APIs

Titanium includes a number of built-in JavaScript objects that are not part of the Titanium namespace, including JSON parsing, String formatting, timers, and the CommonJS require function. See Global APIs for details.

  • 0.8
  • 0.8
  • 0.8
Defined By

Properties

apiName : Stringreadonly

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.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Indicates if the proxy will bubble an event to its parent. ...

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

  • 3.0.0
  • 3.0.0
  • 3.0.0
Titanium
buildDate : Stringreadonly

Date of the Titanium build.

Date of the Titanium build.

Titanium
buildHash : Stringreadonly

Git hash of the Titanium build.

Git hash of the Titanium build.

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.

  • 3.6.0
Titanium
userAgent : String

User-agent string used by Titanium.

User-agent string used by Titanium.

Titanium
version : Stringreadonly

Version of Titanium that is executing.

Version of Titanium that is executing.

Defined By

Methods

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

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Titanium
( params ) : Titanium.Buffer
Creates a new buffer based on the params. ...

Creates a new buffer based on the params.

Examples

Create a buffer with 1K bytes

var buffer = Ti.createBuffer({ length: 1024 });

Create a buffer with string

Create a buffer with the string "hello world" encoded in UTF-8

var buffer = Ti.createBuffer({ value: "hello world" });

Create a buffer with encoded float

Create a buffer with the encoded value of the double-precision floating point number 1.234567 in Big Endian (network) byte order

var buffer = Ti.createBuffer({ value: 1.234567, type: Ti.Codec.TYPE_DOUBLE, byteOrder: Ti.Codec.BIG_ENDIAN });

Parameters

Returns

Titanium
( [parameters] ) : Titanium.Proxy
Creates and returns an instance of Titanium.Proxy. ...

Creates and returns an instance of Titanium.Proxy.

Parameters

Returns

Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Titanium
( ) : String
Gets the value of the buildDate property. ...

Gets the value of the buildDate property.

Returns

  • String
Titanium
( ) : String
Gets the value of the buildHash property. ...

Gets the value of the buildHash property.

Returns

  • String
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium
( ) : String
Gets the value of the userAgent property. ...

Gets the value of the userAgent property.

Returns

  • String
Titanium
( ) : String
Gets the value of the version property. ...

Gets the value of the version property.

Returns

  • String
Removes the specified callback as an event listener for the named event. ...

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 : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium
( userAgent )
Sets the value of the userAgent property. ...

Sets the value of the userAgent property.

Parameters

  • userAgent : String

    New value for the property.

Returns

  • void