Usage: Sync health data manually

Sync Health Connect data by yourself.

info

The automatic implementation is faster and easier to integrate and is what most developers need, try to use it before attempting to create a custom sync process.

Sync health data manually

There are 2 types of health data Summaries and Events.

Health Data	Timezone	Oldest date of retrieval	Latest date of retrieval	Class
Summary	UTC	29 days	Yesterday	RookSyncManager
Event	UTC	29 days	Today	RookSyncManager

You can call RookSyncManager functions by creating an instance with a context:

val rookSyncManager = RookSyncManager(context)

rookSyncManager.doSomething()

Or using the Companion object and providing a context with each call:

RookSyncManager.doSomething(context)

Sync summaries

Use sync(enableLogs: Boolean) to sync the last 29 days of SLEEP_SUMMARY, PHYSICAL_SUMMARY and BODY_SUMMARY (not including today).

danger

If the app goes to the background the synchronization will fail, use launchInForegroundService. instead if you want the synchronization to continue until it finishes (launchInForegroundService will not only sync summaries, but also events).

rookSyncManager.sync(enableLogs = isDebug).fold(
    {
        // Historic summaries sync started
    },
    {
        // Handle error
    },
)

Use sync(date: LocalDate) to sync SLEEP_SUMMARY, PHYSICAL_SUMMARY and BODY_SUMMARY for the provided date.

rookSyncManager.sync(date = localDate).fold(
    {
        // Summaries synced successfully
    },
    {
        // Handle error
    },
)

Use sync(date: LocalDate, summary: SyncType.Summary) to sync the summary of choice for the provided date.

rookSyncManager.sync(date = localDate, summary = summary).fold(
    {
        // Summary synced successfully
    },
    {
        // Handle error
    },
)

Sync events

Use syncEvents(date: LocalDate, event: SyncType.Event) to sync the event of choice for the provided date.

rookSyncManager.syncEvents(date = localDate, event = event).fold(
    {
        // Event synced successfully
    },
    {
        // Handle error
    },
)

Sync current day events

Current day events allow to send small amounts of health data, but they also return the data that was sent, you can use this data to update your UI without waiting for the webhook event.

Steps events

Retrieve and upload current day steps count of Health Connect.

rookSyncManager.getTodayStepsCount().fold(
    {
        when (it) {
            SyncStatusWithData.RecordsNotFound -> {
                // No steps events found
            }

            is SyncStatusWithData.Synced -> {
                val steps: Int = it.data

                // Update the UI with steps count
            }
        }
    },
    {
        // Handle error
    }
)

Warning: This function contributes to the Health Connect rate limit, don't call it too frequently.

Calories events

Retrieve and upload current day calories count of Health Connect.

rookSyncManager.getTodayCaloriesCount().fold(
    {
        when (it) {
            SyncStatusWithData.RecordsNotFound -> {
                // No calories events found
            }

            is SyncStatusWithData.Synced -> {
                val dailyCalories: DailyCalories = it.data

                // Update the UI with calories count
            }
        }
    },
    {
        // Handle error
    }
)

Warning: This function contributes to the Health Connect rate limit, don't call it too frequently.

Javadoc

See the complete specification of RookSyncManager in the Javadoc