Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update getSamples.md #180

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

docs: Update getSamples.md #180

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/getSamples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,33 @@

Query to get all activities of given type with extended information about it.

Sample types:

| Options Types | Permissions Required |
| ------------------------- | --------------------- |
| `'Walking'` | AppleHealthKit.Constants.Permissions.StepCount, AppleHealthKit.Constants.Permissions.DistanceWalkingRunning |
| `'StairClimbing'` | AppleHealthKit.Constants.Permissions.FlightsClimbed |
| `'Running'` | AppleHealthKit.Constants.Permissions.DistanceWalkingRunning |
| `'Cycling'` | AppleHealthKit.Constants.Permissions.StepCount |
| `'Workout'` | AppleHealthKit.Constants.Permissions.Workout |

Permissions added to permissions request depend on the type of samples. Make sure the correct permissions are added for the sample type(s) desired.

For example: Walking Samples

```javascript
const PERMS = AppleHealthKit.Constants.Permissions;

const permissions = {
permissions: {
read: [
PERMS.DistanceWalkingRunning,
PERMS.StepCount,
],
},
};
```

Example input options:

```javascript
Expand Down