Overview Package Class Tree Deprecated Index

java.lang.Object
- com.samsung.android.service.health.tracking.HealthTracker

public class HealthTracker
extends Object

HealthTracker enables an application to set an event listener and receive the Galaxy Watch's sensor data for a specific HealthTrackerType.

Before getting a HealthTracker instance, check the Galaxy Watch's capabilities using:

HealthTrackerCapability.getSupportHealthTrackerTypes()

     // Connection with Health Platform succeeded. Check capability.
     List<HealthTrackerType> availableTrackers = healthTrackingService.getTrackingCapability().getSupportHealthTrackerTypes();
     if (!availableTrackers.contains(HealthTrackerType.ECG_ON_DEMAND)) {
         // Tracking Electrocardiogram (ECG) On-Demand is not available.
         // Display a proper message to the user. 
     } else {
         ecgTracker = healthTrackingService.getHealthTracker(HealthTrackerType.ECG_ON_DEMAND);
     }

Since:: 1.0.0
See Also:: HealthTracker.TrackerEventListener
HealthTrackerType

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HealthTracker.TrackerError` Errors thrown by `HealthTracker`'s event listener.
`static interface`	`HealthTracker.TrackerEventListener` `TrackerEventListener` receives a sensor data event callback.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`flush()` Flush gathered health data.
`void`	`setEventListener(HealthTracker.TrackerEventListener listener)` Set an event listener for this `HealthTracker` instance.
`void`	`setExerciseData(DataType type, float[] data, long[] timestamp)` Set exercise data along with timestamp, to get sweat loss data.
`void`	`setExerciseState(ExerciseState state)` Set an exercise state.
`void`	`unsetEventListener()` Stop the registered event listener for this `HealthTracker` instance.

- Method Detail
  - setEventListener
```
public void setEventListener(HealthTracker.TrackerEventListener listener)
```
    Set an event listener for this HealthTracker instance. If it succeeds, the event listener exists and retrieves sensor data until the unsetEventListener() call.
    Only one HealthTracker.TrackerEventListener should be set per HealthTrackerType. Be careful not to register multiple event listeners for the same health tracker type.
    
    Parameters:
    
    listener - an implemented TrackerEventListener.
    
    Since:
    
    1.0.0
  - setExerciseData
```
public void setExerciseData(DataType type,
                            float[] data,
                            long[] timestamp)
```
    Set exercise data along with timestamp, to get sweat loss data.
    
    Parameters:
    
    type - a data type to set exercise data like DataType.STEP_PER_MINUTE.
    
    data - an array of exercise data corresponding to DataType.STEPS_PER_MINUTE in ExerciseUpdateListener.onExerciseUpdate().
    
    timestamp - an array of timestamp for each exercise data point.
    
    Throws:
    
    IllegalArgumentException - if the data array size is more than 200 or the data value is negative.
    
    IllegalArgumentException - if the timestamp array is not sorted or values are not in Epoch.
    
    IllegalArgumentException - if the timestamp values are earlier than starting the exercise.
    
    IllegalStateException - if this method is called before setExerciseState( ExerciseState.START) is called.
    
    Since:
    
    1.0.0
  - setExerciseState
```
public void setExerciseState(ExerciseState state)
```
    Set an exercise state.
    
    Setting ExerciseState.START again in the same application is ignored if the exercise was started already.
    If another application calls setExerciseState( ExerciseState.START), the first application's exercise is automatically terminated and sweat loss data for it is returned. The other application then works normally.
    
    Parameters:
    
    state - An exercise state with ExerciseState.START or ExerciseState.STOP.
    
    Throws:
    
    IllegalStateException - if it is called before setEventListener(HealthTracker.TrackerEventListener).
    
    IllegalStateException - if setExerciseState( ExerciseState.STOP) is called before setExerciseState( ExerciseState.START).
    
    Since:
    
    1.0.0
  - unsetEventListener
```
public void unsetEventListener()
```
    Stop the registered event listener for this HealthTracker instance.
    
    Since:
    
    1.0.0
  - flush
```
public boolean flush()
```
    Flush gathered health data. This method provides gathered data instantly.
    After flushing, the registered event listener will work continuously until unsetEventListener() is called.
    For example, if an event listener for HealthTrackerType.HEART_RATE_CONTINUOUS has been registered, the Health Platform gathers heart rate data until the batch data is retrieved periodically. If 120 heart rate data were gathered and flush() is called, the Health Platform sends an event to TrackerEventListener.onFlushCompleted and the gathered 120 data is retrieved in TrackerEventListener.onDataReceived.
    Afterwards, the Health Platform gathers heart rate data again and sends the gathered data with a batch process.
    
    If no data has been collected, TrackerEventListener.onFlushCompleted is called without triggering TrackerEventListener.onDataReceived.
    
    Only the following tracker types support the flush() API. Otherwise, it returns false.
    Returns:
    
    true if the flush was successful.
    false if the flush failed or no event listener was registered.
    
    Since:
    
    1.0.0
    
    See Also:
    
    setEventListener(HealthTracker.TrackerEventListener)
    HealthTracker.TrackerEventListener.onFlushCompleted
    
    Remark:
    
    Calling this API too frequently can lead to increased watch battery consumption. Be careful not to misuse it.

Class HealthTracker

Nested Class Summary

Method Summary

Method Detail

setEventListener

setExerciseData

setExerciseState

unsetEventListener

flush

Manage Your Cookies

Essential Cookies

Analytical/Performance Cookies

Functionality Cookies

Advertising Cookies

Preferences Submitted