@perfood/capacitor-google-fit

Capacitor plugin to read data from Google Fit.

Install

npm install @perfood/capacitor-google-fit
npx cap sync

API

• connect()
• disable()
• logout()
• open()
• isAllowed()
• isPermissionGranted()
• isInstalled()
• getHistory(...)
• getHistoryActivity(...)
• addListener('googleFitAllowed', ...)
• Interfaces

connect()

connect() => Promise<void>

Connect to Google Fit

disable()

disable() => Promise<void>

Disable Google Fit

logout()

logout() => Promise<void>

Logout from Google Fit

open()

open() => Promise<void>

Open

isAllowed()

isAllowed() => Promise<AllowedResult>

Returns wether the permissions are ok or not

Returns: Promise<AllowedResult>

isPermissionGranted()

isPermissionGranted() => Promise<AllowedResult>

Check if permission is granted

Returns: Promise<AllowedResult>

isInstalled()

isInstalled() => Promise<{ value: boolean; }>

Check if Google Fit is installed

Returns: Promise<{ value: boolean; }>

getHistory(...)

getHistory(call: QueryInput) => Promise<DayContainer>

Get history

| Param | Type | | ---------- | ------------------------------------------------- | | call | QueryInput |

Returns: Promise<DayContainer>

getHistoryActivity(...)

getHistoryActivity(call: QueryInput) => Promise<ActivityContainer>

Get history activity

| Param | Type | | ---------- | ------------------------------------------------- | | call | QueryInput |

Returns: Promise<ActivityContainer>

addListener('googleFitAllowed', ...)

addListener(eventName: 'googleFitAllowed', listenerFunc: (info: GoogleFitPermissionData) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | ---------------------------------------------------------------------------------------------- | | eventName | 'googleFitAllowed' | | listenerFunc | (info: GoogleFitPermissionData) => void |

Returns: Promise<PluginListenerHandle>

Interfaces

AllowedResult

| Prop | Type | | ------------- | -------------------- | | allowed | boolean |

DayContainer

| Prop | Type | | ---------- | -------------------------- | | days | HistoryData[] |

HistoryData

| Prop | Type | Description | | -------------- | ------------------- | ------------------------------------------------------------------ | | start | string | | | end | string | | | distance | string | Distance travelled in meters. Valid range: 0—100 meters per second | | speed | string | meters per second | | calories | string | |

QueryInput

| Prop | Type | | --------------- | ------------------------------------- | | startTime | Date | | endTime | Date |

Date

Enables basic storage and retrieval of dates and times.

| Method | Signature | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | | toString | () => string | Returns a string representation of a date. The format of the string depends on the locale. | | toDateString | () => string | Returns a date as a string value. | | toTimeString | () => string | Returns a time as a string value. | | toLocaleString | () => string | Returns a value as a string value appropriate to the host environment's current locale. | | toLocaleDateString | () => string | Returns a date as a string value appropriate to the host environment's current locale. | | toLocaleTimeString | () => string | Returns a time as a string value appropriate to the host environment's current locale. | | valueOf | () => number | Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC. | | getTime | () => number | Gets the time value in milliseconds. | | getFullYear | () => number | Gets the year, using local time. | | getUTCFullYear | () => number | Gets the year using Universal Coordinated Time (UTC). | | getMonth | () => number | Gets the month, using local time. | | getUTCMonth | () => number | Gets the month of a Date object using Universal Coordinated Time (UTC). | | getDate | () => number | Gets the day-of-the-month, using local time. | | getUTCDate | () => number | Gets the day-of-the-month, using Universal Coordinated Time (UTC). | | getDay | () => number | Gets the day of the week, using local time. | | getUTCDay | () => number | Gets the day of the week using Universal Coordinated Time (UTC). | | getHours | () => number | Gets the hours in a date, using local time. | | getUTCHours | () => number | Gets the hours value in a Date object using Universal Coordinated Time (UTC). | | getMinutes | () => number | Gets the minutes of a Date object, using local time. | | getUTCMinutes | () => number | Gets the minutes of a Date object using Universal Coordinated Time (UTC). | | getSeconds | () => number | Gets the seconds of a Date object, using local time. | | getUTCSeconds | () => number | Gets the seconds of a Date object using Universal Coordinated Time (UTC). | | getMilliseconds | () => number | Gets the milliseconds of a Date, using local time. | | getUTCMilliseconds | () => number | Gets the milliseconds of a Date object using Universal Coordinated Time (UTC). | | getTimezoneOffset | () => number | Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC). | | setTime | (time: number) => number | Sets the date and time value in the Date object. | | setMilliseconds | (ms: number) => number | Sets the milliseconds value in the Date object using local time. | | setUTCMilliseconds | (ms: number) => number | Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC). | | setSeconds | (sec: number, ms?: number | undefined) => number | Sets the seconds value in the Date object using local time. | | setUTCSeconds | (sec: number, ms?: number | undefined) => number | Sets the seconds value in the Date object using Universal Coordinated Time (UTC). | | setMinutes | (min: number, sec?: number | undefined, ms?: number | undefined) => number | Sets the minutes value in the Date object using local time. | | setUTCMinutes | (min: number, sec?: number | undefined, ms?: number | undefined) => number | Sets the minutes value in the Date object using Universal Coordinated Time (UTC). | | setHours | (hours: number, min?: number | undefined, sec?: number | undefined, ms?: number | undefined) => number | Sets the hour value in the Date object using local time. | | setUTCHours | (hours: number, min?: number | undefined, sec?: number | undefined, ms?: number | undefined) => number | Sets the hours value in the Date object using Universal Coordinated Time (UTC). | | setDate | (date: number) => number | Sets the numeric day-of-the-month value of the Date object using local time. | | setUTCDate | (date: number) => number | Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC). | | setMonth | (month: number, date?: number | undefined) => number | Sets the month value in the Date object using local time. | | setUTCMonth | (month: number, date?: number | undefined) => number | Sets the month value in the Date object using Universal Coordinated Time (UTC). | | setFullYear | (year: number, month?: number | undefined, date?: number | undefined) => number | Sets the year of the Date object using local time. | | setUTCFullYear | (year: number, month?: number | undefined, date?: number | undefined) => number | Sets the year value in the Date object using Universal Coordinated Time (UTC). | | toUTCString | () => string | Returns a date converted to a string using Universal Coordinated Time (UTC). | | toISOString | () => string | Returns a date as a string value in ISO format. | | toJSON | (key?: any) => string | Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization. |

ActivityContainer

| Prop | Type | | ---------------- | ---------------------------------- | | activities | HistoryActivityData[] |

HistoryActivityData

| Prop | Type | | ---------------- | ------------------- | | start | string | | end | string | | distance | string | | speed | string | | calories | string | | activity | string | | weight | string | | steps | string | | sourceName | string | | sourceType | string |

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

GoogleFitPermissionData

| Prop | Type | | ----------- | ----------------------------------- | | value | 'success' | 'failure' |