{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Learn how to setup your mobile project for compatibility with the Sahha SDK"]},{"$$mdtype":"Tag","name":"h2","attributes":{"id":"choose-your-platform"},"children":["Choose your platform:"]},{"$$mdtype":"Tag","name":"PlatformLinks","attributes":{},"children":[{"$$mdtype":"Tag","name":"PlatformLink","attributes":{"label":"iOS","href":"/docs/guides/sdk/setup#i-os"},"children":[]},{"$$mdtype":"Tag","name":"PlatformLink","attributes":{"label":"Android","href":"/docs/guides/sdk/setup#android"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h2","attributes":{"id":"i-os"},"children":["iOS"]},{"$$mdtype":"Tag","name":"PlatformLinks","attributes":{},"children":[{"$$mdtype":"Tag","name":"PlatformLink","attributes":{"label":"iOS","href":"/docs/guides/sdk/setup"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Follow these steps to setup your iOS project:"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h3","attributes":{"id":"step-1-enable-health-kit"},"children":["Step 1) Enable HealthKit"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you can connect to Apple Health, you must enable the HealthKit capabilities for your app."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You add capabilities to your app using the Signing & Capabilities pane of the project editor."]},{"$$mdtype":"Tag","name":"Callout","attributes":{"title":"Add `HealthKit` entitlement to your Xcode project"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select your App Target in the Project panel"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"Signing & Capabilities"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tap the ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"+"},"children":[]}," button"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"HealthKit"},"children":[]}," from the list"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Double-click the capability to add it to your project"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h4","attributes":{"id":"step-1-1"},"children":["Step 1.1"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the Project navigator of the main window, select the project — the root group with the same name as your app — and in the project editor that appears, select the appropriate target and then click the Signing & Capabilities tab."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/health-kit/hk_capability_1.png","alt":"Using HealthKit"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h4","attributes":{"id":"step-1-2"},"children":["Step 1.2"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the toolbar, click the Library button (+) to open the Capabilities library. Alternatively, click + Capability to the left of the build configurations, or choose Editor > Add Capability. The Capabilities library displays only the capabilities available to the target platform and your program membership. Select a capability in the list to view its description on the right."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/health-kit/hk_capability_2.png","alt":"Using HealthKit"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h4","attributes":{"id":"step-1-3"},"children":["Step 1.3"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"HealthKit"},"children":[]}," from the list of capabilities."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/health-kit/hk_capability_3.png","alt":"Using HealthKit"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h4","attributes":{"id":"step-1-4"},"children":["Step 1.4"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After you add the HealthKit capability, Xcode links the HealthKit framework to your target and updates the target’s entitlements file to include the HealthKit Entitlement. If Xcode automatically manages the signing of your app, it also enables HealthKit for your app’s App ID."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h3","attributes":{"id":"step-2-background-delivery"},"children":["Step 2) Background Delivery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In order for the Sahha SDK to passively collect health data, your app will need to enable background delivery for HealthKit."]},{"$$mdtype":"Tag","name":"Callout","attributes":{"title":"Add `Background Delivery` capability to your Xcode project"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To enable HealthKit run even while your app is in the background, perform the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select your project in Xcode’s Project navigator."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select the app’s target from the Targets list."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click the Signing & Capabilities tab in the project editor."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Find the HealthKit capability."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enable the nested Background Delivery capability."]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Xcode adds the ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"com.apple.developer.healthkit.background-delivery"},"children":[]}," entitlement to the target’s entitlements file."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/health-kit/hk_background_delivery.png","alt":"Using HealthKit"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h3","attributes":{"id":"step-3-add-usage-descriptions"},"children":["Step 3) Add Usage Descriptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["HealthKit uses a fine-grained authorization mechanism to help protect the user’s privacy; your app must request permission to read and, optionally, write each individual sample type it supports."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before prompting the user for their permission, you must configure your app to include one or more purpose strings, which accurately and concisely describe why the app needs to read the user’s health data, write health data to their HealthKit store, or both. The presence of these purpose strings is an App Store requirement for any app that integrates with HealthKit. The system displays this information to the user when requesting their permission, along with the specific sample types that your app needs to access, which helps them make an informed decision."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You will need to write a message explaining to the user why they should approve these permissions."]},{"$$mdtype":"Tag","name":"Callout","attributes":{"title":"Add usage descriptions to your Xcode project"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Follow these steps to add the usage description for reading health data to your app’s target:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select your App Target in the Project panel"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"Info"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tap the ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"+"},"children":[]}," button to add a new key"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Choose ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"Privacy - Health Share Usage Description"},"children":[]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Write a clear description for the key value such as ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"This app needs your health info to deliver mood predictions."},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/health-kit/hk_share_usage.png","alt":"Using HealthKit"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h2","attributes":{"id":"android"},"children":["Android"]},{"$$mdtype":"Tag","name":"PlatformLinks","attributes":{},"children":[{"$$mdtype":"Tag","name":"PlatformLink","attributes":{"label":"Android","href":"/docs/guides/sdk/setup"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Follow these steps to setup your Android project:"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h3","attributes":{"id":"step-1-edit-your-android-manifest"},"children":["Step 1) Edit your AndroidManifest"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In order to access your user's device sensors, you will need to include the correct ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"uses-permission"},"children":[]}," values in your project's AndroidManifest.xml."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Choose your framework to follow the correct steps:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"labels":["Android","Flutter","React Native"]},"children":[{"$$mdtype":"Tag","name":"Tab","attributes":{"label":"Android"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Step 1) Find the project’s ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"AndroidManifest.xml"},"children":[]}," file. This is located in the project’s ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"app/src/main"},"children":[]}," folder."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/sdk-install/android-manifest-1.png","alt":"Android Manifest"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Step 2) Within the file, declare the permissions between the manifest and application code."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/sdk-install/android-manifest-2.png","alt":"Android Manifest"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Step 3) Here is an example declaring ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"Heart"},"children":[]}," and ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"Activity"},"children":[]}," permissions. Make sure to save the file!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/sdk-install/android-manifest-3.png","alt":"Android Manifest"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Tab","attributes":{"label":"Flutter"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Step 1) Find the project’s ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"AndroidManifest.xml"},"children":[]}," file. This is located in the project’s ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"android/app/src/main"},"children":[]}," folder."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/sdk-install/flutter-android-manifest-1.png","alt":"Android Manifest"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Step 2) Within the file, declare the permissions between the manifest and application code."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/sdk-install/flutter-android-manifest-2.png","alt":"Android Manifest"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Step 3) Here is an example declaring ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"Heart"},"children":[]}," and ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"Activity"},"children":[]}," permissions. Make sure to save the file!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/sdk-install/flutter-android-manifest-3.png","alt":"Android Manifest"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Tab","attributes":{"label":"React Native"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Step 1) Find the project’s ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"AndroidManifest.xml"},"children":[]}," file. This is located in the project’s ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"android/app/src/main"},"children":[]}," folder."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/sdk-install/react-native-android-manifest-1.png","alt":"Android Manifest"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Step 2) Within the file, declare the permissions between the manifest and application code."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/sdk-install/react-native-android-manifest-2.png","alt":"Android Manifest"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Step 3) Here is an example declaring ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"Heart"},"children":[]}," and ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"Activity"},"children":[]}," permissions. Make sure to save the file!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/sdk-install/react-native-android-manifest-3.png","alt":"Android Manifest"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h3","attributes":{"id":"step-2-review-sensor-permissions"},"children":["Step 2) Review Sensor Permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each sensor has an associated ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"user-permission"},"children":[]}," values. Only include the sensor values required by your project. You can see the full list below."]},{"$$mdtype":"Tag","name":"Fence","attributes":{"language":"xml","content":"\n\n \n \n\n \n \n \n \n \n\n \n \n\n \n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n"},"children":["\n\n \n \n\n \n \n \n \n \n\n \n \n\n \n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n\n \n \n"]},{"$$mdtype":"Tag","name":"Callout","attributes":{"title":"Device Sensor"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Please note ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"SahhaSensor.device_lock"},"children":[]}," does not require any AndroidManifest.xml permission declarations."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h3","attributes":{"id":"step-3-specify-your-sensors"},"children":["Step 3) Specify your Sensors"]},{"$$mdtype":"Tag","name":"Callout","attributes":{"title":"Specifying Sensors for Android","type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For every sensor you specify in ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"getSensorStatus"},"children":[]}," or ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"enableSensors"},"children":[]},", you will need to include matching ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"uses-permission"},"children":[]}," values in your AndroidManifest.xml."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"InlineLink","attributes":{"href":"/docs/guides/sdk/sensors#android-uses-permission-important-info"},"children":["View the SDK Sensors documentation"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the values do not match, you are likely to receive build errors and risk your app being rejected on the Google Play Store!"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, if your project requires the ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"step_count"},"children":[]}," and ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"sleep"},"children":[]}," sensors, then included the following ",{"$$mdtype":"Tag","name":"Code","attributes":{"content":"uses-permission"},"children":[]}," values:"]},{"$$mdtype":"Tag","name":"Fence","attributes":{"language":"xml","content":"\n\n\n\n\t\n \n\n \n \n\n\t\n\t\t...\n\t\n\n"},"children":["\n\n\n\n\t\n \n\n \n \n\n\t\n\t\t...\n\t\n\n"]}]}

Overview

Error Monitoring