Global

The replacement is done by a Babel plugin during JS transpilation phase of the app build. This is an easy way to guard deploy type-specific codepaths (and make it easier for Babel to strip away dead code paths).

This pre-define originally lived in Alloy compilation but has been migrated to the SDK build process.

The replacement is done by a Babel plugin during JS transpilation phase of the app build. This is an easy way to guard deploy type-specific codepaths (and make it easier for Babel to strip away dead code paths).

This pre-define originally lived in Alloy compilation but has been migrated to the SDK build process.

The replacement is done by a Babel plugin during JS transpilation phase of the app build. This is an easy way to guard deploy type-specific codepaths (and make it easier for Babel to strip away dead code paths).

This pre-define originally lived in Alloy compilation but has been migrated to the SDK build process.

The replacement is done by a Babel plugin during JS transpilation phase of the app build. This is an easy way to guard deploy type-specific codepaths (and make it easier for Babel to strip away dead code paths).

This pre-define originally lived in Alloy compilation but has been migrated to the SDK build process.

The replacement is done by a Babel plugin during JS transpilation phase of the app build. This is an easy way to guard deploy type-specific codepaths (and make it easier for Babel to strip away dead code paths).

This pre-define originally lived in Alloy compilation but has been migrated to the SDK build process.

This value is replaced by an injected boolean literal value indicating if the current platform is Android.

The replacement is done by a Babel plugin during JS transpilation phase of the app build. This is an easy way to guard platform-specific codepaths (and make it easier for Babel to strip away dead code paths).

This pre-define originally lived in Alloy compilation but has been migrated to the SDK build process.

This value is replaced by an injected boolean literal value indicating if the current platform is ipad/iphone.

The replacement is done by a Babel plugin during JS transpilation phase of the app build. This is an easy way to guard platform-specific codepaths (and make it easier for Babel to strip away dead code paths).

This pre-define originally lived in Alloy compilation but has been migrated to the SDK build process.

This returns the same value as the Titanium.Platform.versionMajor property.

if (OS_IOS && (OS_VERSION_MAJOR >= 13)) {
    // Do something on iOS 13 or higher only.
}

This returns the same value as the Titanium.Platform.versionMinor property.

Will return zero if the OS does not have a minor version.

This returns the same value as the Titanium.Platform.versionPatch property.

Will return zero if the OS does not have a patch version.

This function is a shortcut for creating and displaying an alert dialog. For example, the following two statements produce the same result.

alert('Danger, Will Robinson!');

Ti.UI.createAlertDialog({ message: 'Danger, Will Robinson!' }).show();

Note that unlike a web browser-based version of alert, the method is asynchronous. However, only one alert dialog will be visible and modal at a time.

Be aware that this method may be removed in the future.

For more information, see the MDN website for encodeURIComponent and decodeURIComponent.

For more information, see the MDN website for encodeURIComponent and decodeURIComponent.

The require function takes a module identifier as its argument and returns an object with references to the module's exported symbols.

ES6+ Syntax

Using Titanium SDK 7.1.0 and later, you can also use the ES6+ import and export syntax by enabling transpiling via the <transpile>true</transpile> property in your tiapp.xml

Native Titanium Module

To load a native Titanium module:

1. Install the module to the project or copy it to the Titanium SDK home directory.
2. Add the module as a dependency to the project by modifying the modules section of the tiapp.xml file.
3. Initialize the module with the require method by passing the module ID to the method.

For detailed instructions, refer to Using a Module.

CommonJS Module

To load a local CommonJS module, place the CommonJS module in the Resources directory of your project. Pass the require method the path to the file without the Resources directory, platform-specific directory and the .js extension.

Note that the appropriate platform-specific Resources subdirectory is merged into the main Resources directory at build time. For example, suppose the following files exist.

• Resources/app.js
• Resources/ui/MainWindow.js
• Resources/iphone/ui/TaskWindow.js
• Resources/android/ui/TaskWindow.js

The appropriate TaskWindow.js file is moved into the Resources/ui directory of the built application. To include both the MainWindow module and the platform-specific TaskWindow module from any JavaScript file in the project:

// load main window module from ui subdirectory
var mainWindow = require('ui/MainWindow');

// load platform-specific task window module
var taskWindow = require('ui/TaskWindow');

For more information, see the official CommonJS website.

Alloy

For Alloy, place the CommonJS modules in the app/lib directory of your Alloy project, then load the module with the require method without the app/lib path and .js extension.

Starting with Alloy 1.5.0, you can add platform-specific directories to the app/lib directory. Do not include the platform-specific directory when referencing the CommonJS module.

For example, a module file app/lib/android/myModule/module.js may be loaded by app/controllers/index.js using:

require('myModule/module');

Android

Additionally, on Android, an absolute path to a module may be specified using a path separator (/) at the beginning of the path.

For example, a module file Resources/myModule/module.js may be required by Resources/example/example.js using either of the following:

require('../myModule/module')
require ('/myModule/module')

var module = require('com.mycompany.module');

exports.message = "hello world";

var myModule = require('myModule');
alert(myModule.message);

Note that although the interval is not guaranteed to be exact, the interval between calls will be no less than the specified delay.

Returns a unique timer identifier that can be passed to clearInterval to cancel this timer.

For more information, see the MDN website for setInterval.

var count = 0;
var timer = setInterval(function() {
    count++;
    label.text = 'count - ' + count;
    if (count == 10) {
        clearInterval(timer);
    }
}, 1000);

Note that although the timeout is not guaranteed to be exact, the delay before the function is invoked will be no less than the specified delay.

Returns a unique timer identifier that can be passed to clearTimeout to cancel this timer.

For more information, see the MDN website for setTimeout.

setTimeout(function() {
    Ti.API.debug('Called using setTimeout');
}, 500);