Titanium SDK # Modules.CoreMotion.MotionActivity
Allows Titanium client applications to access CoreMotion's MotionActivity APIs.
5.2.0# Properties
# apiName READONLY
5.2.0The 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
5.2.0Indicates 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
# Methods
# addEventListener
5.2.0Adds 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
5.2.0Applies 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
# fireEvent
5.2.0Fires 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
# isActivityAvailable
5.2.0Returns a Boolean indicating whether motion activity data is available on the current device.
Returns
- Type
- Boolean
# queryActivity
5.2.0Gathers and returns historical motion activity data for the specified time period.
This method runs asynchronously, returning immediately and delivering the results to the specified callback. The system stores only the last seven days worth of activity data at most. If there are no samples for the specified range of time, an error object with the code ERROR_UNKNOWN is passed to the callback.
Parameters
| Name | Type | Description |
|---|---|---|
args | CoreMotionQueryActivityArgs | An object of arguments |
callback | Callback<CoreMotionActivityQueryDataWithSuccess> | The callback to execute with the results. |
Returns
- Type
- void
# removeEventListener
5.2.0Removes 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 |
Returns
- Type
- void
# startActivityUpdates
5.2.0Starts the delivery of current motion activity updates to your app.
This method initiates the tracking of motion data asynchronously. Upon calling this method, the motion activity manager executes the callback, reporting the current motion in effect for the device. After that, the motion activity manager executes the callback only when the motion data changes.
The callback is executed on a best effort basis and updates are not delivered while your app is suspended. If updates arrived while your app was suspended, the last update is delivered to your app when it resumes execution. To get all of the updates that occurred while your app was suspended, use the queryActivity method.
Upon starting activity updates, the motion activity manager reports changes to its callback until you call the stopActivityUpdates method. If you call this method again with a new callback, the activity manager stops delivering updates to the old callback and delivers them to the new callback instead.
Parameters
| Name | Type | Description |
|---|---|---|
callback | Callback<CoreMotionActivityData> | The method to be called when there is an update. |
Returns
- Type
- void
# stopActivityUpdates
5.2.0Stops the delivery of motion activity updates to your app.
Returns
- Type
- void