Titanium.API
The top-level API module, containing methods to output messages to the system log.
Extends: Titanium.Module · Since: 0.1
Properties #
apiName#
Type: 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, Button
returns Ti.UI.Button.
bubbleParent#
Type: 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.
lifecycleContainer#
Type: 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 #
Adds the specified callback as an event listener for the named event.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. | No |
applyProperties #
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.
| Name | Type | Summary | Optional |
|---|---|---|---|
props | Dictionary | A dictionary of properties to apply. | No |
debug #
Logs messages with a debug severity-level.
| Name | Type | Summary | Optional |
|---|---|---|---|
message | Array<String>, String | Message to log. Accepts an array on iOS only. | No |
error #
Logs messages with an error severity-level.
| Name | Type | Summary | Optional |
|---|---|---|---|
message | Array<String>, String | Message to log. Accepts an array on iOS only. | No |
fireEvent #
Fires a synthesized event to any registered listeners.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. | Yes |
info #
Logs messages with an info severity-level.
| Name | Type | Summary | Optional |
|---|---|---|---|
message | Array<String>, String | Message to log. Accepts an array on iOS only. | No |
log #
Logs messages with the specified severity-level.
| Name | Type | Summary | Optional |
|---|---|---|---|
level | String | Log level. One of info, warn, error, debug and trace. If the value is notrecognized, an info-level message prefixed with the value is logged. | No |
message | Array<String>, String | Message to log. Accepts an array on iOS only. | No |
removeEventListener #
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);
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to addEventListener. | No |
timestamp #
Logs messages with a timestamp severity-level, prefixed with a timestamp float number
representing the number of seconds since January 1st, 2001.
| Name | Type | Summary | Optional |
|---|---|---|---|
message | Array<String>, String | Message to log. Accepts an array on iOS only. | No |
trace #
Logs messages with a trace severity-level.
| Name | Type | Summary | Optional |
|---|---|---|---|
message | Array<String>, String | Message to log. Accepts an array on iOS only. | No |
warn #
Logs messages with a warn severity-level.
| Name | Type | Summary | Optional |
|---|---|---|---|
message | Array<String>, String | Message to log. Accepts an array on iOS only. | No |