Titanium SDK

# API Reference

Welcome to the API documentation for Titanium SDK!

# Titanium

Titanium SDK provides a root namespace object, Titanium as the base/root for the APIs. This object is also frequently accessed by its alias, Ti.

const button = Titanium.UI.createButton({ title: 'Send' });
// `Ti` convenience shorthand
const win = Ti.UI.createWindow({ title: 'Home' });

You'll find all APIs arranged under this root namespace. Browse the full list of available APIs via the sidebar to the left or check out the most frequently used ones in the groups below.

User Interface

UI
Root namespace for UI related code/widgets
View
The base type for UI elements in Titanium and building block for your own UI.
Label
Fully stylable label to display one or multiple lines of text.
List View
A list view is used to present rows of information, such as an item list or menu.

Network, Filesystem and I/O

Network
Root namespace for network related code, such as an HTTP client.
Filesystem
Root namespace for interacting with the filesystem.
Stream
Utility methods for reading/writing to/from streams.
Buffer
A read/write instance of bytes typically used in conjunction with streams.

Media

Media
Access the device's media-related functionality, such as the device's camera or photo gallery.
Audio Player
Stream audio to the device and control playback.
Music Player
Lets you manage and playback a queue of media objects.
Video Player
Play local video files or stream from a remote server, either in fullscreen or embedded in other views.

Sensors

Accelerometer
Register for events when the device's x/y/z rotation changes.
Geolocation
Requesting and accessing location coordinates and geocoding addresses.
Gesture
Query for device orientation and register for orientation changes or shake events.

SQLite Database

Database
Root namespace for APIs to manage Databases
DB
An instance of a Database
ResultSet
Result Sets from querying/manipulating a Database

Utilities

DisplayCaps
Provides details on the specific hardware densities and dimensions of the device
App
Access app-specific data at runtime, such as name, id, or version and for sending or listening for system events.
Properties
Store app related data that persists beyond app sessions and device power cycles.
Utils
Utility for base64 encode/decode, as well as sha/md5 hashing

Logging

API
A Titanium-specific logger.

# Modules

Titanium SDK also has a concept of Native Modules - these are 1st and 3rd-party APIs that may be added on/imported.

Some of these modules get shipped with the SDK, but must be opted-in to be used in your app. Others you may need to download and install into your app or in your Titanium SDK global modules directory.

You opt-in to use of a module per-app by adding a reference to the module in your tiapp.xml file:

<!-- ... -->
<modules>
  <module>ti.map</module>
</modules>
<!-- ... -->

# Globals

In addition to the root Titanium namespace hanging off the global, we also supplement the global object with additional APIs/extensions commonly used on Node.JS and on the web.

Most notable:

  • console - a Node.JS and Web-compatible implementation of the console object, used primarly for logging.
  • global - The global object is hung off of itself to allow for typical explicit access, i.e. global.console.