terra-capacitor

Wrap TerraiOS and TerraAndroid for capacitor projects

Install

npm install terra-capacitor
npx cap sync

API

• echo(...)
• initTerra(...)
• initConnection(...)
• getUserId(...)
• getBody(...)
• getActivity(...)
• getDaily(...)
• getNutrition(...)
• getMenstruation(...)
• getSleep(...)
• getAthlete(...)
• activateSensor()
• readGlucoseData()
• Interfaces
• Type Aliases
• Enums

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

Param	Type
options	{ value: string; }

Returns: Promise<{ value: string; }>

---

initTerra(...)

initTerra(options: { devId: string; referenceId: string | null; }) => Promise<SuccessMessage>

Param	Type
options	{ devId: string; referenceId: string | null; }

Returns: Promise<SuccessMessage>

---

initConnection(...)

initConnection(options: { connection: Connections; token: string; schedulerOn: boolean; customPermissions: CustomPermissions[]; startIntent: string | null; }) => Promise<any>

Param	Type
options	{ connection: Connections; token: string; schedulerOn: boolean; customPermissions: CustomPermissions[]; startIntent: string | null; }

Returns: Promise<any>

---

getUserId(...)

getUserId(options: { connection: Connections; }) => Promise<GetUserId>

Param	Type
options	{ connection: Connections; }

Returns: Promise<GetUserId>

---

getBody(...)

getBody(options: { connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }) => Promise<DataMessage>

Param	Type
options	{ connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }

Returns: Promise<DataMessage>

---

getActivity(...)

getActivity(options: { connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }) => Promise<DataMessage>

Param	Type
options	{ connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }

Returns: Promise<DataMessage>

---

getDaily(...)

getDaily(options: { connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }) => Promise<DataMessage>

Param	Type
options	{ connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }

Returns: Promise<DataMessage>

---

getNutrition(...)

getNutrition(options: { connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }) => Promise<DataMessage>

Param	Type
options	{ connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }

Returns: Promise<DataMessage>

---

getMenstruation(...)

getMenstruation(options: { connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }) => Promise<DataMessage>

Param	Type
options	{ connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }

Returns: Promise<DataMessage>

---

getSleep(...)

getSleep(options: { connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }) => Promise<DataMessage>

Param	Type
options	{ connection: Connections; startDate: Date; endDate: Date; toWebhook: boolean; }

Returns: Promise<DataMessage>

---

getAthlete(...)

getAthlete(options: { connection: Connections; toWebhook: boolean; }) => Promise<DataMessage>

Param	Type
options	{ connection: Connections; toWebhook: boolean; }

Returns: Promise<DataMessage>

---

activateSensor()

activateSensor() => Promise<DataMessage>

Returns: Promise<DataMessage>

---

readGlucoseData()

readGlucoseData() => Promise<DataMessage>

Returns: Promise<DataMessage>

---

Interfaces

Object

Provides functionality common to all JavaScript objects.

Prop	Type	Description
constructor	Function	The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Method	Signature	Description
toString	() => string	Returns a string representation of an object.
toLocaleString	() => string	Returns a date converted to a string using the current locale.
valueOf	() => Object	Returns the primitive value of the specified object.
hasOwnProperty	(v: PropertyKey) => boolean	Determines whether an object has a property with the specified name.
isPrototypeOf	(v: Object) => boolean	Determines whether an object exists in another object's prototype chain.
propertyIsEnumerable	(v: PropertyKey) => boolean	Determines whether a specified property is enumerable.

Function

Creates a new function.

Prop	Type
prototype	any
length	number
arguments	any
caller	Function

Method	Signature	Description
apply	(this: Function, thisArg: any, argArray?: any) => any	Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.
call	(this: Function, thisArg: any, ...argArray: any[]) => any	Calls a method of an object, substituting another object for the current object.
bind	(this: Function, thisArg: any, ...argArray: any[]) => any	For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.
toString	() => string	Returns a string representation of a function.

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.

Type Aliases

SuccessMessage

{ success: boolean; error: string | null; }

GetUserId

{ success: boolean; userId: string | null; }

DataMessage

{ success: boolean; data: Object; error: string | null; }

PropertyKey

string | number | symbol

Enums

Connections

Members	Value
'APPLE_HEALTH'	'APPLE_HEALTH'
'FREESTYLE_LIBRE'	'FREESTYLE_LIBRE'
'GOOGLE'	'GOOGLE'
'SAMSUNG'	'SAMSUNG'

CustomPermissions

Members	Value
'WORKOUT_TYPES'	'WORKOUT_TYPES'
'ACTIVITY_SUMMARY'	'ACTIVITY_SUMMARY'
'LOCATION'	'LOCATION'
'CALORIES'	'CALORIES'
'STEPS'	'STEPS'
'HEART_RATE'	'HEART_RATE'
'HEART_RATE_VARIABILITY'	'HEART_RATE_VARIABILITY'
'VO2MAX'	'VO2MAX'
'HEIGHT'	'HEIGHT'
'ACTIVE_DURATIONS'	'ACTIVE_DURATIONS'
'WEIGHT'	'WEIGHT'
'FLIGHTS_CLIMBED'	'FLIGHTS_CLIMBED'
'BMI'	'BMI'
'BODY_FAT'	'BODY_FAT'
'EXERCISE_DISTANCE'	'EXERCISE_DISTANCE'
'GENDER'	'GENDER'
'DATE_OF_BIRTH'	'DATE_OF_BIRTH'
'BASAL_ENERGY_BURNED'	'BASAL_ENERGY_BURNED'
'SWIMMING_SUMMARY'	'SWIMMING_SUMMARY'
'RESTING_HEART_RATE'	'RESTING_HEART_RATE'
'BLOOD_PRESSURE'	'BLOOD_PRESSURE'
'BLOOD_GLUCOSE'	'BLOOD_GLUCOSE'
'BODY_TEMPERATURE'	'BODY_TEMPERATURE'
'MINDFULNESS'	'MINDFULNESS'
'LEAN_BODY_MASS'	'LEAN_BODY_MASS'
'OXYGEN_SATURATION'	'OXYGEN_SATURATION'
'SLEEP_ANALYSIS'	'SLEEP_ANALYSIS'
'RESPIRATORY_RATE'	'RESPIRATORY_RATE'
'NUTRITION_SODIUM'	'NUTRITION_SODIUM'
'NUTRITION_PROTEIN'	'NUTRITION_PROTEIN'
'NUTRITION_CARBOHYDRATES'	'NUTRITION_CARBOHYDRATES'
'NUTRITION_FIBRE'	'NUTRITION_FIBRE'
'NUTRITION_FAT_TOTAL'	'NUTRITION_FAT_TOTAL'
'NUTRITION_SUGAR'	'NUTRITION_SUGAR'
'NUTRITION_VITAMIN_C'	'NUTRITION_VITAMIN_C'
'NUTRITION_VITAMIN_A'	'NUTRITION_VITAMIN_A'
'NUTRITION_CALORIES'	'NUTRITION_CALORIES'
'NUTRITION_WATER'	'NUTRITION_WATER'
'NUTRITION_CHOLESTEROL'	'NUTRITION_CHOLESTEROL'