Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/perfood/capacitor-healthkit
Capacitor plugin to interact with HealthKit
https://github.com/perfood/capacitor-healthkit
Last synced: 2 months ago
JSON representation
Capacitor plugin to interact with HealthKit
- Host: GitHub
- URL: https://github.com/perfood/capacitor-healthkit
- Owner: perfood
- Created: 2020-02-12T13:55:27.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T06:19:10.000Z (4 months ago)
- Last Synced: 2024-11-18T02:44:24.346Z (2 months ago)
- Language: Swift
- Homepage: https://www.npmjs.com/package/@perfood/capacitor-healthkit
- Size: 3.71 MB
- Stars: 62
- Watchers: 8
- Forks: 47
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-capacitor - Healthkit - Retrieve data from HealthKit. (Other plugins)
README
# Capacitor HealthKit Plugin
:heart: Capacitor plugin to retrieve data from HealthKit :heart:
Disclaimer : _for now only some of the HK data base, in the future the retrieve base will be bigger !_
## Getting Started
### Prerequisites
* Add **HealthKit to your Xcode project** (section signing & capabilities)
* ADD **Privacy - Health Share Usage Description** to your Xcode project
* ADD **Privacy - Health Update Usage Description** to your Xcode project
You can simply put this into the `info.plist` file
```
NSHealthShareUsageDescription
Read Health Data
NSHealthUpdateUsageDescription
Read Health Data
```
### Installing
Do
```
npm i --save @perfood/capacitor-healthkit
```
Then
```
npx cap update
```
And **if you use Ionic or Angular, here a example setup:**
in your .ts file add this:
```
import {
ActivityData,
CapacitorHealthkit,
OtherData,
QueryOutput,
SampleNames,
SleepData,
} from '@perfood/capacitor-healthkit';
const READ_PERMISSIONS = ['calories', 'stairs', 'activity', 'steps', 'distance', 'duration', 'weight'];
```
and then you can create async functions like this:
```
public async requestAuthorization(): Promise {
try {
await CapacitorHealthkit.requestAuthorization({
all: [''],
read: READ_PERMISSIONS,
write: [''],
});
} catch (error) {
console.error('[HealthKitService] Error getting Authorization:', error);
}
}
private async getActivityData(
startDate: Date,
endDate: Date = new Date(),
): Promise> | undefined {
try {
const queryOptions = {
sampleName: SampleNames.WORKOUT_TYPE,
startDate: startDate.toISOString(),
endDate: endDate.toISOString(),
limit: 0,
};
return await CapacitorHealthkit.queryHKitSampleType(queryOptions);
} catch (error) {
console.error(error);
return undefined;
}
}
```
so you can use the plugin for example with the call `CapacitorHealthkit.queryHKitSampleType(...`
And you're all set ! :+1:
* [`requestAuthorization(...)`](#requestauthorization)
* [`queryHKitSampleType(...)`](#queryhkitsampletype)
* [`isAvailable()`](#isavailable)
* [`multipleQueryHKitSampleType(...)`](#multiplequeryhkitsampletype)
* [`isEditionAuthorized(...)`](#iseditionauthorized)
* [`multipleIsEditionAuthorized(...)`](#multipleiseditionauthorized)
* [Interfaces](#interfaces)
### requestAuthorization(...)
```typescript
requestAuthorization(authOptions: AuthorizationQueryOptions) => Promise
```
This functions will open the iOS Screen to let users choose their permissions. Keep in mind as developers, if the access has been denied by the user we will have no way of knowing - the query results will instead just be empty arrays.
| Param | Type | Description |
| ----------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| **`authOptions`** | AuthorizationQueryOptions | These define which access we need. Possible Options include ['calories', 'stairs', 'activity', 'steps', 'distance', 'duration', 'weight']. |
--------------------
### queryHKitSampleType(...)
```typescript
queryHKitSampleType(queryOptions: SingleQueryOptions) => Promise>
```
This defines a query to the Healthkit for a single type of data.
| Param | Type | Description |
| ------------------ | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **`queryOptions`** | SingleQueryOptions | defines the type of data and the timeframe which shall be queried, a limit can be set to reduce the number of results. |
**Returns:** Promise<QueryOutput<T>>
--------------------
### isAvailable()
```typescript
isAvailable() => Promise
```
This functions resolves if HealthKitData is available it uses the native HKHealthStore.isHealthDataAvailable() funtion of the HealthKit .
--------------------
### multipleQueryHKitSampleType(...)
```typescript
multipleQueryHKitSampleType(queryOptions: MultipleQueryOptions) => Promise
```
This defines a query to the Healthkit for a single type of data. This function has not been tested.
| Param | Type | Description |
| ------------------ | --------------------------------------------------------------------- | ------------------------------------------------- |
| **`queryOptions`** | MultipleQueryOptions | defines the sample types which can be queried for |
**Returns:** Promise<any>
--------------------
### isEditionAuthorized(...)
```typescript
isEditionAuthorized(queryOptions: EditionQuery) => Promise
```
Checks if there is writing permission for one specific sample type. This function has not been tested.
| Param | Type | Description |
| ------------------ | ----------------------------------------------------- | -------------------------------------------------------------------------- |
| **`queryOptions`** | EditionQuery | defines the sampletype for which you need to check for writing permission. |
--------------------
### multipleIsEditionAuthorized(...)
```typescript
multipleIsEditionAuthorized(queryOptions: MultipleEditionQuery) => Promise
```
Checks if there is writing permission for multiple sample types. This function has not been tested.
| Param | Type | Description |
| ------------------ | --------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| **`queryOptions`** | MultipleEditionQuery | defines the sampletypes for which you need to check for writing permission. |
--------------------
### Interfaces
#### AuthorizationQueryOptions
Used for authorization of reading and writing access.
| Prop | Type |
| ----------- | --------------------- |
| **`read`** | string[] |
| **`write`** | string[] |
| **`all`** | string[] |
#### QueryOutput
This interface is used for any results coming from HealthKit. It always has a count and the actual results.
| Prop | Type |
| ----------------- | ------------------- |
| **`countReturn`** | number |
| **`resultData`** | T[] |
#### SingleQueryOptions
This extends the Basequeryoptions for a single sample type.
| Prop | Type |
| ---------------- | ------------------- |
| **`sampleName`** | string |
#### MultipleQueryOptions
This extends the Basequeryoptions for a multiple sample types.
| Prop | Type |
| ----------------- | --------------------- |
| **`sampleNames`** | string[] |
#### EditionQuery
This is used for checking writing permissions.
| Prop | Type |
| ---------------- | ------------------- |
| **`sampleName`** | string |
#### MultipleEditionQuery
This is used for checking writing permissions.
| Prop | Type |
| ----------------- | ---------------------- |
| **`sampleNames`** | string[] |
## Credits
* Theo Creach (original author) - [Twitter](https://twitter.com/crcht)
* Timothée Bilodeau - [Linkedin](https://www.linkedin.com/in/timoth%E9e-bilodeau-03080ab2/)
## License
This project is licensed under the MIT License