Titanium SDK # Modules.CoreMotion.Pedometer
Allows Titanium client applications to access CoreMotion's Pedometer APIs. Note: This API is only available in iOS 8 and later.
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
# isCadenceAvailable
5.2.0Returns a Boolean value indicating whether cadence information is available on the current device. Note: This API is only available on iOS 9 and later.
Returns
- Type
- Boolean
# isDistanceAvailable
5.2.0Returns a Boolean value indicating whether distance support is available on the current device.
Returns
- Type
- Boolean
# isFloorCountingAvailable
5.2.0Returns a Boolean value indicating whether floor counting is available on the current device.
Returns
- Type
- Boolean
# isPaceAvailable
5.2.0Returns a Boolean value indicating whether pace information is available on the current device. Note: This API is only available on iOS 9 and later.
Returns
- Type
- Boolean
# isStepCountingAvailable
5.2.0Returns a Boolean indicating whether step-counting support is available on the current device.
Returns
- Type
- Boolean
# isSupported DEPRECATED
5.2.0DEPRECATED SINCE 8.3.0
This API is supported on IOS 8+ and this module is now targeting iOS 8 as minimum, so this method will always return true.
Returns a Boolean value indicating whether the pedometer is supported on the current device. Returns true for iOS 8+.
Returns
- Type
- Boolean
# queryPedometerData
5.2.0Retrieves the data between the specified start and end dates.
Use this method to retrieve historical pedestrian data between the specified dates. This method runs asynchronously and delivers the data to the block you provide. Only the past seven days worth of data is stored and available for you to retrieve. Specifying a start date that is more than seven days in the past returns only the available data.
It is safe to call this method at the same time that you are generating continuous updates using the startPedometerUpdates method.
Parameters
| Name | Type | Description |
|---|---|---|
args | CoreMotionStartPedometerArgs | An object of arguments |
callback | Callback<CoreMotionPedometerDataWithSuccess> | 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
# startPedometerUpdates
5.2.0Starts the delivery of recent pedestrian-related data to your app.
Upon calling this method, the pedometer object starts calling your handler block regularly with data. The data passed to your handler block represents the cumulative data starting at the specified start date and ending at the current time. (You can get the start and end dates from the CMPedometerData object passed to your handler.) This method initiates the event delivery process asynchronously and executes your block on a serial dispatch queue, which ensures that only one copy of the block runs at any given time.
When the app is suspended, the delivery of updates stops temporarily. Upon returning to foreground or background execution, the pedometer object begins updates again.
To stop the delivery of events, call the stopPedometerUpdates method.
Parameters
| Name | Type | Description |
|---|---|---|
args | CoreMotionStartPedometerArgs | An object of arguments |
callback | Callback<CoreMotionPedometerDataWithSuccess> | The callback to execute with the results. |
Returns
- Type
- void
# stopPedometerUpdates
5.2.0Stops the delivery of recent pedestrian data updates to your app.
Use this method to stop the delivery of continuous updates that were initiated by a call to the startPedometerUpdates method.
Returns
- Type
- void