📄️ Getting started
What follows in the Fundamentals section of this documentation is a tour of the most important aspects of the ROOK SDK. It should cover enough for you to know how to integrate us into your application.
📄️ Grant Permissions
The ROOK SDK requires that the user explicitly grant permissions to access and extract the data contained in Health Connect (Android) and Apple Health (iOS).
📄️ Update User ID
Before any data sync, we need to set or configure a user to identify the data and later know who owns the information. We recommend configuring this after your login using the updateUserId function of RookConfig like this:
📄️ Configure Background
Setting background functions allows us to send new information as we receive notifications. This helps to resend that information to you through your webhook previously configured in the ROOK Portal.
📄️ Manual Sync
Use the sync function to manually trigger synchronization of health summary data. This is useful when you want to ensure the latest data from a specific date or data source is uploaded to ROOK.
📄️ Steps
This feature retrieves the step count for the current day. Use the object RookEvents class, which includes the getTodayStepCount function to obtain the current step count.
📄️ Calories
This feature retrieves the calories count for the current day. Use the object RookEvents class, which includes the getTodayCalories function to obtain the current calories burned count.