6.0.2 • Published 1 year ago
Share package @perfood/capacitor-healthkit v2 This is a complete re-write of the original plugin and still work in progress. v2 will have a complete new API and some new features. By far not everything has been implemented yet. You can test the most recent release of v2 by installing @perfood/capacitor-healthkit@next.
Install npm install @perfood/capacitor-healthkit@next
npx cap syncAPI requestAuthorization(...) requestAuthorization(options: RequestAuthorizationOptions) => Promise<void>Param Type optionsRequestAuthorizationOptions
isAvailable() isAvailable() => Promise<void>getAuthorizationStatus(...) getAuthorizationStatus(options: GetAuthorizationStatusOptions) => Promise<{ status: AuthorizationStatus; }>Param Type optionsGetAuthorizationStatusOptions
Returns: Promise<{ status: AuthorizationStatus; }>
getStatisticsCollection(...) getStatisticsCollection(options: StatisticsCollectionOptions) => Promise<StatisticsCollectionOutput>Param Type optionsStatisticsCollectionOptions
Returns: Promise<StatisticsCollectionOutput>
getBodyMassEntries(...) getBodyMassEntries(options: BodyMassQueryOptions) => Promise<BodyMassQueryOutput>Param Type optionsBodyMassQueryOptions
Returns: Promise<BodyMassQueryOutput>
getWorkouts(...) getWorkouts(options: WorkoutsQueryOptions) => Promise<WorkoutsQueryOutput>Param Type optionsWorkoutsQueryOptions
Returns: Promise<WorkoutsQueryOutput>
Interfaces RequestAuthorizationOptions Prop Type allstring[] readstring[] writestring[]
GetAuthorizationStatusOptions StatisticsCollectionOutput Prop Type data{ startDate: string; endDate: string; value: number; }[]
StatisticsCollectionOptions Prop Type startDatestring endDatestring anchorDatestring intervalStatisticsCollectionQueryInterval quantityTypeSampleNameQuantityType
StatisticsCollectionQueryInterval Prop Type unit'second' | 'minute' | 'hour' | 'day' | 'month' | 'year' valuenumber
BodyMassQueryOutput Prop Type data{ date: string; value: number; unit: string; uuid: string; sourceName: string; sourceBundleId: string; }[]
BodyMassQueryOptions Prop Type startDatestring endDatestring limitnumber
WorkoutsQueryOutput Prop Type data{ uuid: string; startDate: string; endDate: string; duration: number; device?: HealthKitDevice; source: string; sourceBundleId: string; workoutActivityType: string; workoutActivityTypeId: number; totalEnergyBurned?: number; totalDistance?: number; totalFlightsClimbed?: number; totalSwimmingStrokeCount?: number; }[]
HealthKitDevice Prop Type namestring modelstring manufacturerstring hardwareVersionstring softwareVersionstring firmwareVersionstring localIdentifierstring udiDeviceIdentifierstring
WorkoutsQueryOptions Prop Type startDatestring endDatestring limitnumber
Type Aliases AuthorizationStatus 'notDetermined' | 'sharingDenied' | 'sharingAuthorized'
QuantityType 'stepCount'