Titanium SDK # Modules.CoreMotion.StepCounter
Allows Titanium client applications to access CoreMotion's (deprecated) StepCounter APIs.
5.2.0DEPRECATED SINCE 5.2.0
This API was deprecated by Apple in iOS 7 and is only available for backward compatibility
with older versions of this module. It will be removed in the next release. Please use
Modules.CoreMotion.Pedometer API instead, which provides the same functionality including
new properties like floorCount and distance.
# 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
# isStepCountingAvailable
5.2.0Returns a Boolean indicating whether step-counting support is available on the current device.
Returns
- Type
- Boolean
# queryStepCount
5.2.0Gathers and returns historical step count data for the specified time period.
The system stores only the last seven days worth of step data at most. If there are no samples for the specified range of time, a value of 0 is passed to the callback.
Parameters
| Name | Type | Description |
|---|---|---|
args | CoreMotionQueryStepCountArgs | An object of arguments |
callback | Callback<CoreMotionStepCountingQueryDataWithSuccess> | 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
# startStepCountingUpdates
5.2.0Starts the delivery of current step-counting data to your app.
This method initiates tracking of the user's steps and calls the callback periodically to deliver the results. When you call this method, the step counter resets the current step count value to 0 and begins counting. Each time the step counter records the number of steps in the stepCounts parameter, it executes the specified callback. For example, if stepCounts is 100, it would send updates at 100 steps, 200 steps, 300 steps, and so on. The number of steps reported to your handler is always the total number of steps since you called this method.
The callback is executed on a best effort basis each time the step count threshold is exceeded. If your app is suspended when the threshold is exceeded, the callback is not executed. When your app resumes, the callback is not executed until the threshold is exceeded again.
To stop the delivery of step-counting updates, call the stopStepCountingUpdates method.
Parameters
| Name | Type | Description |
|---|---|---|
args | CoreMotionStartStepCountingArgs | An object of arguments |
callback | Callback<CoreMotionStepCountingDataWithSuccess> | The callback to execute with the results. |
Returns
- Type
- void
# stopStepCountingUpdates
5.2.0Stops the delivery of step-counting updates to your app.
Call this method to stop the delivery of updates that you started by calling the <Modules.CoreMotion.startStepCountingUpdates> method. This method does not stop queries started using the queryStepCount method.
Returns
- Type
- void