# Titanium.API

The top-level API module, containing methods to output messages to the system log.

Availability

0.8

9.2.0

Extends

Titanium.Module

# Properties

# apiName READONLY

Availability

3.2.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

3.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

# lifecycleContainer

Availability

3.6.0

lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

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.

# Methods

# addEventListener

Availability

0.8

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

3.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

# debug

Availability

0.8

9.2.0

debug(message) → void

Logs messages with a debug severity-level.

Parameters

Name	Type	Description
`message`	Array<String> \| String	Message to log. Accepts an array on iOS only.

Returns

Type: void

# error

Availability

0.8

9.2.0

error(message) → void

Logs messages with an error severity-level.

Parameters

Name	Type	Description
`message`	Array<String> \| String	Message to log. Accepts an array on iOS only.

Returns

Type: void

# fireEvent

Availability

0.8

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

# info

Availability

0.8

9.2.0

info(message) → void

Logs messages with an info severity-level.

Parameters

Name	Type	Description
`message`	Array<String> \| String	Message to log. Accepts an array on iOS only.

Returns

Type: void

# log

Availability

0.8

9.2.0

log(level, message) → void

Logs messages with the specified severity-level.

Parameters

Name	Type	Description
`level`	String	Log level. One of `info`, `warn`, `error`, `debug` and `trace`. If the value is not recognized, an info-level message prefixed with the value is logged.
`message`	Array<String> \| String	Message to log. Accepts an array on iOS only.

Returns

Type: void

# removeEventListener

Availability

0.8

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

# timestamp

Availability

0.8

9.2.0

timestamp(message) → void

Logs messages with a timestamp severity-level, prefixed with a timestamp float number representing the number of seconds since January 1st, 2001.

Parameters

Name	Type	Description
`message`	Array<String> \| String	Message to log. Accepts an array on iOS only.

Returns

Type: void

# trace

Availability

0.8

9.2.0

trace(message) → void

Logs messages with a trace severity-level.

Parameters

Name	Type	Description
`message`	Array<String> \| String	Message to log. Accepts an array on iOS only.

Returns

Type: void

# warn

Availability

0.8

9.2.0

warn(message) → void

Logs messages with a warn severity-level.

Parameters

Name	Type	Description
`message`	Array<String> \| String	Message to log. Accepts an array on iOS only.

Returns

Type: void