Module: Toybox.UserProfile
Overview
The UserProfile module will allow apps to access user information.
The module contains the GENDER_* enum to retrieve gender information from the user profile. The HR_ZONE_SPORT_* enum also provides constants for defining different sport type. This is used to retrieve Heart Rate Zones specific to that sport.
Classes Under Namespace
Classes: Profile, UserActivity, UserActivityHistoryIterator
Constant Summary
-
Gender
-
SportHrZone
Name | Value | Since | Description | See Also |
---|---|---|---|---|
GENDER_FEMALE | 0 | API Level 1.0.0 |
||
GENDER_MALE | 1 | API Level 1.0.0 |
||
GENDER_UNSPECIFIED | 2 | API Level 4.2.3 |
Name | Value | Since | Description | See Also |
---|---|---|---|---|
HR_ZONE_SPORT_GENERIC | 0 | API Level 1.2.6 |
||
HR_ZONE_SPORT_RUNNING | 1 | API Level 1.2.6 |
||
HR_ZONE_SPORT_BIKING | 2 | API Level 1.2.6 |
||
HR_ZONE_SPORT_SWIMMING | 3 | API Level 1.2.6 |
Instance Method Summary collapse
-
getCurrentSport() as UserProfile.SportHrZone
Return the sport for which the current activity retrieves heart rate zone thresholds.
-
getHeartRateZones(sport as UserProfile.SportHrZone) as Lang.Array<Lang.Number>
Retrieve an Array of the current heart rate zone threshold values in beats per minute (bpm) The returned Array contains zone values as follows: * min zone 1 - The minimum heart rate threshold for zone 1 * max zone 1 - The maximum heart rate threshold for zone 1 * max zone 2 - The maximum heart rate threshold for zone 2 * max zone 3 - The maximum heart rate threshold for zone 3 * max zone 4 - The maximum heart rate threshold for zone 4 * max zone 5 - The maximum heart rate threshold for zone 5.
-
getProfile() as UserProfile.Profile
Retrieve the current Profile object.
-
getUserActivityHistory() as UserProfile.UserActivityHistoryIterator
Get an iterator for Activity history for the user.
Instance Method Details
getCurrentSport() as UserProfile.SportHrZone
Return the sport for which the current activity retrieves heart rate zone thresholds.
If the active sport does not have sport specific zones, it will return HR_ZONE_SPORT_GENERIC.
getHeartRateZones(sport as UserProfile.SportHrZone) as Lang.Array<Lang.Number>
Retrieve an Array of the current heart rate zone threshold values in beats per minute (bpm)
The returned Array contains zone values as follows:
-
min zone 1 - The minimum heart rate threshold for zone 1
-
max zone 1 - The maximum heart rate threshold for zone 1
-
max zone 2 - The maximum heart rate threshold for zone 2
-
max zone 3 - The maximum heart rate threshold for zone 3
-
max zone 4 - The maximum heart rate threshold for zone 4
-
max zone 5 - The maximum heart rate threshold for zone 5
getProfile() as UserProfile.Profile
Retrieve the current Profile object.
getUserActivityHistory() as UserProfile.UserActivityHistoryIterator
Get an iterator for Activity history for the user