Deprecated: Sync health data manually

Sync Health Connect data by yourself.

danger

This section is deprecated, latest synchronization functions are documented here

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	HCRookSummaryManager
Event	UTC	29 days	Today	HCRookEventManager

Sync summaries

To sync any type of summary, you need to provide a date. This date cannot be the current day and cannot be older than 29 days. See the examples below:

Current date	Provided date	Is valid?
2023-01-08	2023-01-08	No, the date is from today
2023-01-08	2023-01-07	Yes, the date is from yesterday
2023-01-08	2022-11-01	No, the date is older than 29 days
2023-01-08	2023-01-01	Yes, the date is 7 days old

To get health data, call sync_xxx_summary and provide a LocalDate instance of the day you want to retrieve the data from.

For example, if you want to sync yesterday's sleep summary, call syncSleepSummary.

Future<void> syncYesterdaySleepSummary() async {
  final today = DateTime.now();
  final yesterday = today.subtract(const Duration(days: 1));

  try {
    await HCRookSummaryManager.syncSleepSummary(yesterday);

    // Success
  } catch (exception) {
    // Handle error
  }
}

Sync pending summaries

When you call sync_xxx_summary, what happens it's that:

1. Health data is extracted from Health Connect
2. The extracted data is enqueued
3. The enqueued data is uploaded to ROOK servers.
4. If success the queued is cleared. Otherwise, the summary is stored.

To retry sending those stored summaries call syncPendingSummaries

void syncPendingSummaries() {
  HCRookSummaryManager.syncPendingSummaries().then((_) {
    // Success
  }).catchError((exception) {
    // Handle error
  });
}

Recommendations

Summaries are collections of health data from a past day, so you should not sync them more than once a day.

/// This function assumes that you have already checked availability and permissions.
Future<void> syncSummaries() async {
  final yesterday = today.subtract(const Duration(days: 1));

  try {
    await HCRookSummaryManager.syncSleepSummary(yesterday);

    // Success
  } catch (exception) {
    // Handle error
  }

  // Sync other types of summaries...

  // Finally you can call syncPendingSummaries to retry all failed uploads (optional)
  // try {
  //   await HCRookSummaryManager.syncPendingSummaries();
  //
  //   // Success
  // } catch (exception) {
  //   // Handle error
  // }
}

• Be cautions of syncing summaries an excessive amount of times, Health Connect has a daily usage limit and your app could be blocked for some hours or a full day.

Sync events

To sync any type of event, you need to provide a date. This date cannot be older than 29 days. See the examples below:

Current date	Provided date	Is valid?
2023-01-08	2023-01-08	Yes, the date is from today
2023-01-08	2023-01-07	Yes, the date is from yesterday
2023-01-08	2022-11-01	No, the date is older than 29 days
2023-01-08	2023-01-01	Yes, the date is 7 days old

To get health data, call sync_xxx_events and provide a LocalDate instance of the day you want to retrieve the data from.

For example, if you want to sync today's physical events, call syncPhysicalEvents.

Future<void> syncTodayPhysicalEvents() async {
  final today = DateTime.now();

  try {
    await HCRookEventManager.syncPhysicalEvents(today);

    // Success
  } catch (exception) {
    // Handle error
  }
}

Sync pending events

When you call sync_xxx_events, what happens it's that:

1. Health data is extracted from Health Connect
2. The extracted data is enqueued
3. The enqueued data is uploaded to ROOK servers.
4. If success the queued is cleared. Otherwise, the events is stored.

To retry sending those stored events call syncPendingEvents

void syncPendingEvents() {
  HCRookEventManager.syncPendingEvents().then((_) {
    // Success
  }).catchError((exception) {
    // Handle error
  });
}

Recommendations

Events are collections of health data divided into intervals of one hour, so you can and should sync them frequently. We recommend that every time your app is opened, you sync events.

Future<void> syncTodayPhysicalEvents() async {
  final today = DateTime.now();

  try {
    await HCRookEventManager.syncPhysicalEvents(today);

    // Success
  } catch (exception) {
    // Handle error
  }

  // Sync other types of events...

  // Finally you can call syncPendingEvents to retry all failed uploads (optional)
  try {
    await HCRookEventManager.syncPendingEvents();

    // Success
  } catch (exception) {
    // Handle error
  }
}

• Be cautious not to sync events excessively. Health Connect has a daily usage limit, and your app could be blocked for some hours or a full day.

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.

void syncStepsEvents() async {
  try {
    final syncStatusWithData =
    await HCRookEventManager.syncTodayHealthConnectStepsCount();

    switch (syncStatusWithData) {
      case Synced(data: final steps):
      // Update the UI with steps count
        break;
      case RecordsNotFound():
      // No steps events found
        break;
    }
  } catch (error) {
    // 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.

void syncCaloriesEvents() async {
  try {
    final syncStatusWithData = await HCRookEventManager.getTodayCaloriesCount();

    switch (syncStatusWithData) {
      case Synced(data: final calories):
      // Update the UI with calories count
        break;
      case RecordsNotFound():
      // No calories events found
        break;
    }
  } catch (error) {
    // Handle error
  }
}

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