import RookSdk from '../NativeRookSdk'; import { useRookSyncGateContext } from '../context/RookSyncGateContext'; import { isModuleReady } from '../utils/isModuleReady'; import isRunningOnAndroid from '../utils/isRunningOnAndroid'; /** * The `useRookAndroidBackgroundSteps` function provides various methods for managing and retrieving * step count data on Android devices using the Rook module. * @returns The `useRookAndroidBackgroundSteps` function returns a hook with the functions that allows the user to * control de steps sync */ export const useRookAndroidBackgroundSteps = () => { const { state: { ready }, } = useRookSyncGateContext(); /** * The function `isStepsAvailable` checks if steps data is available. * @returns The function `isStepsAvailable` is returning a promise that resolve in a boolean value. */ const isStepsAvailable = async (): Promise => { isRunningOnAndroid(); isModuleReady(ready); return RookSdk.isStepsAvailable(); }; /** * The function `enableBackgroundAndroidSteps` starts collecting of steps during the day * @returns The `enableBackgroundAndroidSteps` function is returning a Promise that resolves to a boolean */ const enableBackgroundAndroidSteps = async (): Promise => { isRunningOnAndroid(); isModuleReady(ready); return RookSdk.enableBackgroundAndroidSteps(); }; /** * The function `disableBackgroundAndroidSteps` stops a process of collecting steps during the day * @returns The function `disableBackgroundAndroidSteps` function is returning a Promise that resolves to a boolean */ const disableBackgroundAndroidSteps = (): Promise => { isRunningOnAndroid(); isModuleReady(ready); return RookSdk.disableBackgroundAndroidSteps(); }; /** * The function `isBackgroundAndroidStepsActive` checks if steps are active and returns a Promise with a boolean * value. * @returns The function is returning a Promise that resolves to a boolean */ const isBackgroundAndroidStepsActive = (): Promise => { isRunningOnAndroid(); isModuleReady(ready); return RookSdk.isBackgroundAndroidStepsActive(); }; /** * The function `getTodayAndroidStepsCount` retrieves the number of steps taken today asynchronously as string. * @returns The function `getTodaySteps` is returning the result of calling */ const syncTodayAndroidStepsCount = (): Promise => { isRunningOnAndroid(); isModuleReady(ready); return RookSdk.syncTodayAndroidStepsCount(); }; return { ready, isStepsAvailable, enableBackgroundAndroidSteps, disableBackgroundAndroidSteps, isBackgroundAndroidStepsActive, syncTodayAndroidStepsCount, }; };