Namespace: GoogleFit
Functions
authorize
▸ authorize(shareTypes, readTypes): Promise<boolean>
Sets up GoogleFit tracking and returns status
Parameters
| Name | Type | Description |
|---|---|---|
shareTypes | GoogleFitDataType[] | e.g. [GoogleFitDataType.Steps] |
readTypes | GoogleFitDataType[] | e.g. [GoogleFitDataType.Steps] |
Returns
Promise<boolean>
Returns status of authentication.
Defined in
deleteWorkouts
▸ deleteWorkouts(startDate, endDate): Promise<boolean>
Deletes all workouts for given time period.
Parameters
| Name | Type | Description |
|---|---|---|
startDate | number | Date | Unix timestamp or Date for start date. |
endDate | number | Date | Unix timestamp or Date for end date. |
Returns
Promise<boolean>
Returns status if no errors occurred.
Defined in
api/googleFit/deleteWorkouts.ts:16
getLatestDataRecord
▸ getLatestDataRecord(dataType): Promise<number>
This method currently works with dataTypes: Weight, Height.
Returns the latest record for specified data type.
Parameters
| Name | Type | Description |
|---|---|---|
dataType | FitnessDataType | e.g. FitnessDataType.Weight |
Returns
Promise<number>
Defined in
api/googleFit/getLatestDataRecord.ts:15
getStatisticTodayTotal
▸ getStatisticTodayTotal(dataType): Promise<number>
Gets statistic total for given data type for current day.
Parameters
| Name | Type |
|---|---|
dataType | FitnessDataType |
Returns
Promise<number>
Defined in
api/googleFit/getStatisticTodayTotal.ts:12
getStatisticWeekDaily
▸ getStatisticWeekDaily(dataType): Promise<DailyData>
Gets statistic daily total for current week of given data type.
Parameters
| Name | Type |
|---|---|
dataType | FitnessDataType |
Returns
Promise<DailyData>
Defined in
api/googleFit/getStatisticWeekDaily.ts:12
getStatisticWeekTotal
▸ getStatisticWeekTotal(dataType): Promise<number>
Gets statistic accumulated total for current week of given data type.
Parameters
| Name | Type |
|---|---|
dataType | FitnessDataType |
Returns
Promise<number>
Defined in
api/googleFit/getStatisticWeekTotal.ts:12
isTrackingAvailable
▸ isTrackingAvailable(readTypes, shareTypes): Promise<boolean>
Returns if specific permission is authorized and available on Android If permissions are authorized, it will enable google fit.
Parameters
| Name | Type | Description |
|---|---|---|
readTypes | GoogleFitDataType[] | List of read permissions to check if tracking is available |
shareTypes | GoogleFitDataType[] | List of write permissions to check if tracking is available |
Returns
Promise<boolean>
Defined in
api/googleFit/isTrackingAvailable.ts:15
queryDailyTotals
▸ queryDailyTotals(dataType, startDate, endDate): Promise<DailyData>
Gets statistic daily total for specified time period.
Parameters
| Name | Type | Description |
|---|---|---|
dataType | FitnessDataType | e.g. FitnessDataType.Steps |
startDate | number | Date | Unix timestamp or Date for record start date. |
endDate | number | Date | Unix timestamp or Date for record end date. |
Returns
Promise<DailyData>
Defined in
api/googleFit/queryDailyTotals.ts:16
queryTotal
▸ queryTotal(dataType, startDate, endDate): Promise<number>
Gets statistic accumulated total for specified time period of given data type.
Parameters
| Name | Type | Description |
|---|---|---|
dataType | FitnessDataType | e.g. FitnessDataType.Steps |
startDate | number | Date | Unix timestamp or Date for record start date. |
endDate | number | Date | Unix timestamp or Date for record end date. |
Returns
Promise<number>
Defined in
api/googleFit/queryTotal.ts:16
writeWorkout
▸ writeWorkout(options): Promise<boolean>
Records given workout data to GoogleFit API
Parameters
| Name | Type | Description |
|---|---|---|
options | Object | - |
options.calories? | number | Activity calories. |
options.description? | string | Activity description. |
options.endDate | number | Date | Unix timestamp or Date for record end date. |
options.identifier | string | Activity identifier. |
options.key | GoogleFitWorkoutType | Activity key e.g. GoogleFitWorkoutType.Running |
options.name | string | Activity name. |
options.startDate | number | Date | Unix timestamp or Date for record start date. |
options.steps? | number | Activity steps. |
Returns
Promise<boolean>
Returns status if no errors occurred.