Deprecated: Sync health data manually

Sync Apple Health 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	N/A	Yesterday	AHRookSummaryManager
Event	UTC	N/A	Today	AHRookEventManager

Sync summaries

To sync any type of summary, you need to provide a date. This date cannot be the current day. 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	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 AHRookSummaryManager.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 Apple Health
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() {
  AHRookSummaryManager.syncPendingSummaries().then((_) {
    // Success
  }).catchError((exception) {
    // Handle error
  });
}

Recommendations

Summaries are collections of health data from a past day, so it's not necessary to sync them many times per day.

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

  try {
    await AHRookSummaryManager.syncSleepSummary(yesterday);

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

  // Sync for other types of summaries...

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

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

Sync events

To sync any type of event, you need to provide a date. 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	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 AHRookEventManager.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 Apple Health
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() {
  AHRookEventManager.syncPendingEvents().then((_) {
    // Success
  }).catchError((exception) {
    // Handle error
  });
}

Recommendations

Events are collections of health data divided in intervals of 1 hour, so you can/should sync them frequently. Our recommendation is that every time your app is opened you should sync events.

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

  try {
    await AHRookEventManager.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 AHRookEventManager.syncPendingEvents();

    // Success
  } catch (exception) {
    // 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 Apple Health.

void syncStepsEvents() async {
  try {
    final steps = await AHRookEventManager.syncTodayAppleHealthStepsCount();

    if (steps != null) {
      // Update the UI with steps count
    } else {
      // No steps events found
    }
  } catch (error) {
    // Handle error
  }
}

Calories events

Retrieve and upload current day calories count of Apple Health.

void syncCaloriesEvents() async {
  try {
    final calories = await AHRookEventManager.getTodayCaloriesCount();

    if (calories != null) {
      // Update the UI with calories count
    } else {
      // No calories events found
    }
  } catch (error) {
    // Handle error
  }
}