HealthConnectManager

public class HealthConnectManager
extends Object

java.lang.Object
   ↳ android.health.connect.HealthConnectManager


This class provides APIs to interact with the centralized HealthConnect storage maintained by the system.

HealthConnect is an offline, on-device storage that unifies data from multiple devices and apps into an ecosystem featuring.

  • APIs to insert data of various types into the system.

The basic unit of data in HealthConnect is represented as a Record object, which is the base class for all the other data types such as StepsRecord.

Summary

Constants

String ACTION_MANAGE_HEALTH_PERMISSIONS

Activity action: Launch UI to manage (e.g. grant/revoke) health permissions.

String ACTION_REQUEST_EXERCISE_ROUTE

Activity action: Launch UI to share the route associated with an exercise session.

String CATEGORY_HEALTH_PERMISSIONS

Used in conjunction with Intent.ACTION_VIEW_PERMISSION_USAGE to launch UI to show an app\u2019s health permission rationale/data policy.

String EXTRA_EXERCISE_ROUTE

An exercise route requested via ACTION_REQUEST_EXERCISE_ROUTE.

String EXTRA_SESSION_ID

A string ID of a session to be used with ACTION_REQUEST_EXERCISE_ROUTE.

Public methods

<T> void aggregate(AggregateRecordsRequest<T> request, Executor executor, OutcomeReceiver<AggregateRecordsResponse<T>, HealthConnectException> callback)

Get aggregations corresponding to request.

<T> void aggregateGroupByDuration(AggregateRecordsRequest<T> request, Duration duration, Executor executor, OutcomeReceiver<List<AggregateRecordsGroupedByDurationResponse<T>>, HealthConnectException> callback)

Get aggregations corresponding to request.

<T> void aggregateGroupByPeriod(AggregateRecordsRequest<T> request, Period period, Executor executor, OutcomeReceiver<List<AggregateRecordsGroupedByPeriodResponse<T>>, HealthConnectException> callback)

Get aggregations corresponding to request.

void deleteRecords(Class<? extends Record> recordType, TimeRangeFilter timeRangeFilter, Executor executor, OutcomeReceiver<VoidHealthConnectException> callback)

Deletes records based on the TimeRangeFilter.

void deleteRecords(List<RecordIdFilter> recordIds, Executor executor, OutcomeReceiver<VoidHealthConnectException> callback)

Deletes records based on RecordIdFilter.

void getChangeLogToken(ChangeLogTokenRequest request, Executor executor, OutcomeReceiver<ChangeLogTokenResponseHealthConnectException> callback)

Get token for {HealthConnectManager#getChangeLogs}.

void getChangeLogs(ChangeLogsRequest changeLogsRequest, Executor executor, OutcomeReceiver<ChangeLogsResponseHealthConnectException> callback)

Get change logs post the time when token was generated.

void insertRecords(List<Record> records, Executor executor, OutcomeReceiver<InsertRecordsResponseHealthConnectException> callback)

Inserts records into the HealthConnect database.

<T extends Record> void readRecords(ReadRecordsRequest<T> request, Executor executor, OutcomeReceiver<ReadRecordsResponse<T>, HealthConnectException> callback)

API to read records based on ReadRecordsRequestUsingFilters or ReadRecordsRequestUsingIds

Number of records returned by this API will depend based on below factors:

When an app with read permission allowed calls the API from background then it will be able to read only its own inserted records and will not get records inserted by other apps.

void updateRecords(List<Record> records, Executor executor, OutcomeReceiver<VoidHealthConnectException> callback)

Updates records into the HealthConnect database.

Inherited methods

Constants

ACTION_MANAGE_HEALTH_PERMISSIONS

Added in API level 34
public static final String ACTION_MANAGE_HEALTH_PERMISSIONS

Activity action: Launch UI to manage (e.g. grant/revoke) health permissions.

Shows a list of apps which request at least one permission of the Health permission group.

Input: Intent.EXTRA_PACKAGE_NAME string extra with the name of the app requesting the action. Optional: Adding package name extras launches a UI to manager (e.g. grant/revoke) for this app.

Constant Value: "android.health.connect.action.MANAGE_HEALTH_PERMISSIONS"

ACTION_REQUEST_EXERCISE_ROUTE

Added in API level 34
public static final String ACTION_REQUEST_EXERCISE_ROUTE

Activity action: Launch UI to share the route associated with an exercise session.

Input: caller must provide `String` extra EXTRA_SESSION_ID

Result will be delivered via [Activity.onActivityResult] with `ExerciseRoute` EXTRA_EXERCISE_ROUTE.

Constant Value: "android.health.connect.action.REQUEST_EXERCISE_ROUTE"

CATEGORY_HEALTH_PERMISSIONS

Added in API level 34
public static final String CATEGORY_HEALTH_PERMISSIONS

Used in conjunction with Intent.ACTION_VIEW_PERMISSION_USAGE to launch UI to show an app\u2019s health permission rationale/data policy.

Note: Used by apps to define an intent filter in conjunction with Intent.ACTION_VIEW_PERMISSION_USAGE that the HC UI can link out to.

Constant Value: "android.intent.category.HEALTH_PERMISSIONS"

EXTRA_EXERCISE_ROUTE

Added in API level 34
public static final String EXTRA_EXERCISE_ROUTE

An exercise route requested via ACTION_REQUEST_EXERCISE_ROUTE.

This is returned for a successful request to access a route associated with an exercise session.

Constant Value: "android.health.connect.extra.EXERCISE_ROUTE"

EXTRA_SESSION_ID

Added in API level 34
public static final String EXTRA_SESSION_ID

A string ID of a session to be used with ACTION_REQUEST_EXERCISE_ROUTE.

This is used to specify route of which exercise session we want to request.

Constant Value: "android.health.connect.extra.SESSION_ID"

Public methods

aggregate

Added in API level 34
public void aggregate (AggregateRecordsRequest<T> request, 
                Executor executor, 
                OutcomeReceiver<AggregateRecordsResponse<T>, HealthConnectException> callback)

Get aggregations corresponding to request.

Parameters
request AggregateRecordsRequest: request for different aggregation. This value cannot be null.

executor Executor: Executor on which to invoke the callback. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.

callback OutcomeReceiver: Callback to receive result of performing this operation. This value cannot be null.

Returns
void This value cannot be null.

aggregateGroupByDuration

Added in API level 34
public void aggregateGroupByDuration (AggregateRecordsRequest<T> request, 
                Duration duration, 
                Executor executor, 
                OutcomeReceiver<List<AggregateRecordsGroupedByDurationResponse<T>>, HealthConnectException> callback)

Get aggregations corresponding to request. Use this API if results are to be grouped by concrete intervals of time, for example 5 Hrs, 10 Hrs etc.

Parameters
request AggregateRecordsRequest: request for different aggregation. This value cannot be null.

duration Duration: Duration on which to group by results This value cannot be null.

executor Executor: Executor on which to invoke the callback. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.

callback OutcomeReceiver: Callback to receive result of performing this operation. This value cannot be null.

aggregateGroupByPeriod

Added in API level 34
public void aggregateGroupByPeriod (AggregateRecordsRequest<T> request, 
                Period period, 
                Executor executor, 
                OutcomeReceiver<List<AggregateRecordsGroupedByPeriodResponse<T>>, HealthConnectException> callback)

Get aggregations corresponding to request. Use this API if results are to be grouped by number of days. This API handles changes in ZoneOffset when computing the data on a per-day basis.

Parameters
request AggregateRecordsRequest: Request for different aggregation. This value cannot be null.

period Period: Period on which to group by results This value cannot be null.

executor Executor: Executor on which to invoke the callback. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.

callback OutcomeReceiver: Callback to receive result of performing this operation. This value cannot be null.

deleteRecords

Added in API level 34
public void deleteRecords (Class<? extends Record> recordType, 
                TimeRangeFilter timeRangeFilter, 
                Executor executor, 
                OutcomeReceiver<VoidHealthConnectException> callback)

Deletes records based on the TimeRangeFilter.

Deletions are performed in a transaction i.e. either all will be deleted or none

Parameters
recordType Class: recordType to perform delete operation on. This value cannot be null.

timeRangeFilter TimeRangeFilter: time filter based on which to delete the records. This value cannot be null.

executor Executor: Executor on which to invoke the callback. This value cannot be null.

callback OutcomeReceiver: Callback to receive result of performing this operation. This value cannot be null.

deleteRecords

Added in API level 34
public void deleteRecords (List<RecordIdFilter> recordIds, 
                Executor executor, 
                OutcomeReceiver<VoidHealthConnectException> callback)

Deletes records based on RecordIdFilter.

Deletions are performed in a transaction i.e. either all will be deleted or none

Parameters
recordIds List: recordIds on which to perform delete operation. This value cannot be null.

executor Executor: Executor on which to invoke the callback. This value cannot be null.

callback OutcomeReceiver: Callback to receive result of performing this operation. This value cannot be null.

Throws
IllegalArgumentException if recordIds is empty

getChangeLogToken

Added in API level 34
public void getChangeLogToken (ChangeLogTokenRequest request, 
                Executor executor, 
                OutcomeReceiver<ChangeLogTokenResponseHealthConnectException> callback)

Get token for {HealthConnectManager#getChangeLogs}. Changelogs requested corresponding to this token will be post the time this token was generated by the system all items that match the given filters.

Tokens from this request are to be passed to {HealthConnectManager#getChangeLogs}

Parameters
request ChangeLogTokenRequest: A request to get changelog token This value cannot be null.

executor Executor: Executor on which to invoke the callback. This value cannot be null.

callback OutcomeReceiver: Callback to receive result of performing this operation. This value cannot be null.

getChangeLogs

Added in API level 34
public void getChangeLogs (ChangeLogsRequest changeLogsRequest, 
                Executor executor, 
                OutcomeReceiver<ChangeLogsResponseHealthConnectException> callback)

Get change logs post the time when token was generated.

Parameters
changeLogsRequest ChangeLogsRequest: The token from HealthConnectManager#getChangeLogToken. This value cannot be null.

executor Executor: Executor on which to invoke the callback. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.

callback OutcomeReceiver: Callback to receive result of performing this operation. This value cannot be null.

insertRecords

Added in API level 34
public void insertRecords (List<Record> records, 
                Executor executor, 
                OutcomeReceiver<InsertRecordsResponseHealthConnectException> callback)

Inserts records into the HealthConnect database. The records returned in InsertRecordsResponse contains the unique IDs of the input records. The values are in same order as records. In case of an error or a permission failure the HealthConnect service, OutcomeReceiver#onError will be invoked with a HealthConnectException.

Parameters
records List: list of records to be inserted. This value cannot be null.

executor Executor: Executor on which to invoke the callback. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.

callback OutcomeReceiver: Callback to receive result of performing this operation. This value cannot be null.

Throws
RuntimeException for internal errors

readRecords

Added in API level 34
public void readRecords (ReadRecordsRequest<T> request, 
                Executor executor, 
                OutcomeReceiver<ReadRecordsResponse<T>, HealthConnectException> callback)

API to read records based on ReadRecordsRequestUsingFilters or ReadRecordsRequestUsingIds

Number of records returned by this API will depend based on below factors:

When an app with read permission allowed calls the API from background then it will be able to read only its own inserted records and will not get records inserted by other apps. This may be less than the total records present for the record type.

When an app with read permission allowed calls the API from foreground then it will be able to read all records for the record type.

App with only write permission but no read permission allowed will be able to read only its own inserted records both when in foreground or background.

An app without both read and write permissions will not be able to read any record and the API will throw Security Exception.

Parameters
request ReadRecordsRequest: Read request based on ReadRecordsRequestUsingFilters or ReadRecordsRequestUsingIds This value cannot be null.

executor Executor: Executor on which to invoke the callback. This value cannot be null.

callback OutcomeReceiver: Callback to receive result of performing this operation. This value cannot be null.

Throws
IllegalArgumentException if request page size set is more than 5000 in ReadRecordsRequestUsingFilters
SecurityException if app without read or write permission tries to read.

updateRecords

Added in API level 34
public void updateRecords (List<Record> records, 
                Executor executor, 
                OutcomeReceiver<VoidHealthConnectException> callback)

Updates records into the HealthConnect database. In case of an error or a permission failure the HealthConnect service, OutcomeReceiver#onError will be invoked with a HealthConnectException.

In case the input record to be updated does not exist in the database or the caller is not the owner of the record then HealthConnectException#ERROR_INVALID_ARGUMENT will be thrown.

Parameters
records List: list of records to be updated. This value cannot be null.

executor Executor: Executor on which to invoke the callback. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.

callback OutcomeReceiver: Callback to receive result of performing this operation. This value cannot be null.

Throws
IllegalArgumentException if at least one of the records is missing both ClientRecordID and UUID.