health-data v0.0.3

health-data

Capacitor Plugin to Retrieve User's Device Step Count on Android

Install

npm install health-data
npx cap sync

API

• echo(...)
• getSteps()
• checkPermission(...)
• openAppSettings()
• Interfaces

Plugin for accessing health data and step counters.

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

Echoes back the provided value.

Returns: Promise<{ value: string; }>

getSteps()

getSteps() => Promise<{ name: string; count: number; }>

Retrieves the step count value from the step counter sensor since it was started. Returns null if the necessary permissions have not been granted. Once the permissions are granted, subsequent calls will return the correct step count value. If the device doesn't have a step counter sensor, it won't return anything, but a message indicating that the sensor is not available will be logged to the console.

Returns: Promise<{ name: string; count: number; }>

checkPermission(...)

checkPermission(options?: CheckPermissionOptions | undefined) => Promise<CheckPermissionResult>

Checks the status of the permission and requests it for the first time if it hasn't been granted. The permission status remains unchanged once it has been granted for the rest of the application usage.

Returns: Promise<CheckPermissionResult>

openAppSettings()

openAppSettings() => Promise<void>

Opens the app settings screen for the current app.

Interfaces

CheckPermissionResult

CheckPermissionOptions