Titanium.API

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

  • 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

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
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.API
( message )
Logs messages with a debug severity-level. ...

Logs messages with a debug severity-level.

Parameters

  • message : Array<String>/String

    Message to log. Accepts an array on iOS only.

Returns

  • void
Titanium.API
( message )
Logs messages with an error severity-level. ...

Logs messages with an error severity-level.

Parameters

  • message : Array<String>/String

    Message to log. Accepts an array on iOS only.

Returns

  • void
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
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.API
( message )
Logs messages with an info severity-level. ...

Logs messages with an info severity-level.

Parameters

  • message : Array<String>/String

    Message to log. Accepts an array on iOS only.

Returns

  • void
Titanium.API
( level, message )
Logs messages with the specified severity-level. ...

Logs messages with the specified severity-level.

Parameters

  • 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

  • void
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.API
( message )
Logs messages with a timestamp severity-level, prefixed with a timestamp float number representing the number of sec...

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

  • 0.8
  • 0.8

Parameters

  • message : Array<String>/String

    Message to log. Accepts an array on iOS only.

Returns

  • void
Titanium.API
( message )
Logs messages with a trace severity-level. ...

Logs messages with a trace severity-level.

Parameters

  • message : Array<String>/String

    Message to log. Accepts an array on iOS only.

Returns

  • void
Titanium.API
( message )
Logs messages with a warn severity-level. ...

Logs messages with a warn severity-level.

Parameters

  • message : Array<String>/String

    Message to log. Accepts an array on iOS only.

Returns

  • void