AthleteServiceImpl (Strava API 0.3.1-SNAPSHOT API)

java.lang.Object
- javastrava.api.v3.service.impl.StravaServiceImpl<AthleteAPI>
- - javastrava.api.v3.service.impl.AthleteServiceImpl

All Implemented Interfaces:

AthleteService, StravaService
```
public class AthleteServiceImpl
extends StravaServiceImpl<AthleteAPI>
implements AthleteService
```
Implementation of AthleteService

Author:

Dan Shannon

Field Summary
- Fields inherited from class javastrava.api.v3.service.impl.StravaServiceImpl
  requestRate, requestRateDaily, restService

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StravaAthlete`	`getAthlete(Integer id)` This request is used to retrieve information about any `athlete` on Strava.
`StravaAthlete`	`getAuthenticatedAthlete()` This request is used to retrieve information about the currently authenticated `athlete`.
`static AthleteService`	`instance(Token token)` Returns an instance of `athlete services`
`List<StravaAthlete>`	`listAllAthleteFriends(Integer athleteId)` Convenience method for returning ALL of an athlete's friends
`List<StravaSegmentEffort>`	`listAllAthleteKOMs(Integer athleteId)` Convenience method for returning ALL of an athlete's KOM's
`List<StravaAthlete>`	`listAllAthletesBothFollowing(Integer athleteId)` Convenience method for returning ALL of the athletes that both the authenticated athlete and the given athlete are following
`List<StravaAthlete>`	`listAllAuthenticatedAthleteFriends()` Convenience method for returning ALL of the authenticated athlete's friends
`List<StravaAthlete>`	`listAthleteFriends(Integer id)` Friends are users an `athlete` is following.
`List<StravaAthlete>`	`listAthleteFriends(Integer id, Paging pagingInstruction)` Friends are users an `athlete` is following.
`List<StravaSegmentEffort>`	`listAthleteKOMs(Integer id)` Returns an array of `segment efforts` representing KOMs/QOMs and course records held by the given athlete.
`List<StravaSegmentEffort>`	`listAthleteKOMs(Integer id, Paging pagingInstruction)` Returns an array of `segment efforts` representing KOMs/QOMs and course records held by the given athlete.
`List<StravaAthlete>`	`listAthletesBothFollowing(Integer id)` Retrieve the `athletes` who both the authenticated athlete and the indicated athlete are following.
`List<StravaAthlete>`	`listAthletesBothFollowing(Integer id, Paging pagingInstruction)` Retrieve the `athletes` who both the authenticated athlete and the indicated athlete are following.
`List<StravaAthlete>`	`listAuthenticatedAthleteFriends()` Friends are users the current `athlete` is following.
`List<StravaAthlete>`	`listAuthenticatedAthleteFriends(Paging pagingInstruction)` Friends are users the current `athlete` is following.
`StravaStatistics`	`statistics(Integer id)` Returns recent (last 4 weeks), year to date and all time stats for a given athlete.
`StravaAthlete`	`updateAuthenticatedAthlete(String city, String state, String country, StravaGender sex, Float weight)` Updates the personal details of the currently authenticated `athlete`.

Methods inherited from class javastrava.api.v3.service.impl.StravaServiceImpl
accessTokenIsValid, getToken, requestRateDailyPercentage, requestRatePercentage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - instance
```
public static AthleteService instance(Token token)
```
    Returns an instance of athlete services
    
    Instances are cached so that if 2 requests are made for the same token, the same instance is returned
    
    Parameters:
    
    token - The Strava access token to be used in requests to the Strava API
    
    Returns:
    
    An instance of the athlete services
  - getAuthenticatedAthlete
```
public StravaAthlete getAuthenticatedAthlete()
```
    Description copied from interface: AthleteService
    
    This request is used to retrieve information about the currently authenticated athlete.
    
    URL GET https://www.strava.com/api/v3/athlete
    
    Specified by:
    
    getAuthenticatedAthlete in interface AthleteService
    
    Returns:
    
    Returns a detailed representation of the athlete
    
    See Also:
    
    AthleteService.getAuthenticatedAthlete()
  - getAthlete
```
public StravaAthlete getAthlete(Integer id)
```
    Description copied from interface: AthleteService
    
    This request is used to retrieve information about any athlete on Strava.
    
    Returns null if athlete does not exist
    
    URL GET https://www.strava.com/api/v3/athletes/:id
    
    Specified by:
    
    getAthlete in interface AthleteService
    
    Parameters:
    
    id - The id of the athlete to be returned
    
    Returns:
    
    Returns a summary representation of the athlete even if the indicated athlete matches the authenticated athlete.
    
    See Also:
    
    AthleteService.getAthlete(java.lang.Integer)
  - updateAuthenticatedAthlete
```
public StravaAthlete updateAuthenticatedAthlete(String city,
                                                String state,
                                                String country,
                                                StravaGender sex,
                                                Float weight)
```
    Description copied from interface: AthleteService
    
    Updates the personal details of the currently authenticated athlete.
    
    Requires write permissions, as requested during the authorization process.
    
    Only updates city, state, country, gender (sex) and weight.
    
    URL PUT https://www.strava.com/api/v3/athlete
    
    Specified by:
    
    updateAuthenticatedAthlete in interface AthleteService
    
    Parameters:
    
    city - The city where the athlete wants Strava to think they live
    
    state - The state, county or whatever the athlete wants Strava to think they live
    
    country - The country where the athlete wants Strava to think they live
    
    sex - The gender the athlete wants Strava to think they identify with
    
    weight - The weight that the athlete wants Strava to believe that they are
    
    Returns:
    
    Detailed representation of the updated athlete
    
    See Also:
    
    AthleteService.updateAuthenticatedAthlete(java.lang.String, java.lang.String, java.lang.String, javastrava.api.v3.model.reference.StravaGender, java.lang.Float)
  - listAthleteKOMs
```
public List<StravaSegmentEffort> listAthleteKOMs(Integer id,
                                                 Paging pagingInstruction)
```
    Description copied from interface: AthleteService
    
    Returns an array of segment efforts representing KOMs/QOMs and course records held by the given athlete.
    
    Results are sorted by date, newest first.
    
    Pagination is supported.
    
    Returns null if athlete with the given id is not found.
    
    URL GET https://www.strava.com/api/v3/athletes/:id/koms
    
    Specified by:
    
    listAthleteKOMs in interface AthleteService
    
    Parameters:
    
    id - The id of the athlete whose KOM's are to be returned
    
    pagingInstruction - (Optional) The page to be returned
    
    Returns:
    
    Returns an array of segment effort summary representations
    
    See Also:
    
    AthleteService.listAthleteKOMs(Integer, Paging)
  - listAuthenticatedAthleteFriends
```
public List<StravaAthlete> listAuthenticatedAthleteFriends(Paging pagingInstruction)
```
    Description copied from interface: AthleteService
    
    Friends are users the current athlete is following. The activities owned by these users will appear in the current athlete's activity feed.
    
    This request is for the authenticated athlete's friends.
    
    Pagination is supported.
    
    URL GET https://www.strava.com/api/v3/athletes/friends
    
    Specified by:
    
    listAuthenticatedAthleteFriends in interface AthleteService
    
    Parameters:
    
    pagingInstruction - (Optional) The page to be returned
    
    Returns:
    
    Returns an array of athlete summary representations.
    
    See Also:
    
    AthleteService.listAuthenticatedAthleteFriends(Paging)
  - listAthleteFriends
```
public List<StravaAthlete> listAthleteFriends(Integer id,
                                              Paging pagingInstruction)
```
    Description copied from interface: AthleteService
    
    Friends are users an athlete is following. The activities owned by these users will appear in the current athlete's activity feed.
    
    If the indicated athlete has blocked the authenticated athlete, the result will be an empty array.
    
    Pagination is supported.
    
    Returns null if athlete with the given id is not found.
    
    URL GET https://www.strava.com/api/v3/athletes/:id/friends
    
    Specified by:
    
    listAthleteFriends in interface AthleteService
    
    Parameters:
    
    id - The id of the athlete whose friends are to be listed
    
    pagingInstruction - (Optional) The page to be returned
    
    Returns:
    
    List of athletes who are friends of the identified athlete. Will be empty if the identified athlete has blocked the currently authenticated athlete.
    
    See Also:
    
    AthleteService.listAthleteFriends(Integer, Paging)
  - listAthletesBothFollowing
```
public List<StravaAthlete> listAthletesBothFollowing(Integer id,
                                                     Paging pagingInstruction)
```
    Description copied from interface: AthleteService
    
    Retrieve the athletes who both the authenticated athlete and the indicated athlete are following.
    
    Pagination is supported.
    
    Returns null if athlete with the given id is not found.
    
    URL GET https://www.strava.com/api/v3/athletes/:id/both-following
    
    Specified by:
    
    listAthletesBothFollowing in interface AthleteService
    
    Parameters:
    
    id - The id of the athlete for whom the list of mutual friends is to be generated
    
    pagingInstruction - (Optional) The page to be returned
    
    Returns:
    
    Returns an array of athlete summary representations.
    
    See Also:
    
    AthleteService.listAthletesBothFollowing(Integer, Paging)
  - listAthleteKOMs
```
public List<StravaSegmentEffort> listAthleteKOMs(Integer id)
```
    Description copied from interface: AthleteService
    
    Returns an array of segment efforts representing KOMs/QOMs and course records held by the given athlete.
    
    Results are sorted by date, newest first.
    
    Pagination is not supported.
    
    Returns null if athlete with the given id is not found.
    
    URL GET https://www.strava.com/api/v3/athletes/:id/koms
    
    Specified by:
    
    listAthleteKOMs in interface AthleteService
    
    Parameters:
    
    id - The id of the athlete whose KOM's are to be returned
    
    Returns:
    
    Returns an array of segment effort summary representations
    
    See Also:
    
    AthleteService.listAthleteKOMs(java.lang.Integer)
  - listAuthenticatedAthleteFriends
```
public List<StravaAthlete> listAuthenticatedAthleteFriends()
```
    Description copied from interface: AthleteService
    
    Friends are users the current athlete is following. The activities owned by these users will appear in the current athlete's activity feed.
    
    This request is for the authenticated athlete's friends.
    
    Pagination is not supported. Returns only the first page of athletes.
    
    URL GET https://www.strava.com/api/v3/athletes/friends
    
    Specified by:
    
    listAuthenticatedAthleteFriends in interface AthleteService
    
    Returns:
    
    Returns an array of athlete summary representations.
    
    See Also:
    
    AthleteService.listAuthenticatedAthleteFriends()
  - listAthleteFriends
```
public List<StravaAthlete> listAthleteFriends(Integer id)
```
    Description copied from interface: AthleteService
    
    Friends are users an athlete is following. The activities owned by these users will appear in the current athlete's activity feed.
    
    If the indicated athlete has blocked the authenticated athlete, the result will be an empty array.
    
    Pagination is not supported. Returns only the first page of athletes.
    
    Returns null if athlete with the given id is not found.
    
    URL GET https://www.strava.com/api/v3/athletes/:id/friends
    
    Specified by:
    
    listAthleteFriends in interface AthleteService
    
    Parameters:
    
    id - The id of the athlete whose friends are to be listed
    
    Returns:
    
    List of athletes who are friends of the identified athlete. Will be empty if the identified athlete has blocked the currently authenticated athlete.
    
    See Also:
    
    AthleteService.listAthleteFriends(java.lang.Integer)
  - listAthletesBothFollowing
```
public List<StravaAthlete> listAthletesBothFollowing(Integer id)
```
    Description copied from interface: AthleteService
    
    Retrieve the athletes who both the authenticated athlete and the indicated athlete are following.
    
    Pagination is not supported. Returns only the first page of athletes.
    
    Returns null if athlete with the given id is not found.
    
    URL GET https://www.strava.com/api/v3/athletes/:id/both-following
    
    Specified by:
    
    listAthletesBothFollowing in interface AthleteService
    
    Parameters:
    
    id - The id of the athlete for whom the list of mutual friends is to be generated
    
    Returns:
    
    Returns an array of athlete summary representations.
    
    See Also:
    
    AthleteService.listAthletesBothFollowing(java.lang.Integer)
  - statistics
```
public StravaStatistics statistics(Integer id)
```
    Description copied from interface: AthleteService
    
    Returns recent (last 4 weeks), year to date and all time stats for a given athlete. Only available for the authenticated athlete.
    
    This is the recommended endpoint when polling for athlete upload events.
    
    Pagination is not supported. Returns all statistics for the athlete.
    
    URL GET https://www.strava.com/api/v3/athletes/:id/stats
    
    Specified by:
    
    statistics in interface AthleteService
    
    Parameters:
    
    id - The id of the athlete (must match authenticated athlete)
    
    Returns:
    
    Strava statistics object; values are in seconds and metres.
    
    See Also:
    
    AthleteService.statistics(Integer)
  - listAllAthleteFriends
```
public List<StravaAthlete> listAllAthleteFriends(Integer athleteId)
```
    Description copied from interface: AthleteService
    
    Convenience method for returning ALL of an athlete's friends
    
    Returns ALL the athlete's friends, regardless of how many there are
    
    Pagination is NOT supported.
    
    Returns null if athlete with the given id is not found.
    
    USE WITH CAUTION - ATHLETES WITH MANY FRIENDS WILL REQUIRE MANY CALLS TO THE STRAVA API
    
    URL GET https://www.strava.com/api/v3/athletes/:id/friends
    
    Specified by:
    
    listAllAthleteFriends in interface AthleteService
    
    Parameters:
    
    athleteId - The athlete whose friends are to be listed
    
    Returns:
    
    List of athlete's friends, or null if the athlete does not exist
    
    See Also:
    
    AthleteService.listAllAthleteFriends(java.lang.Integer)
  - listAllAuthenticatedAthleteFriends
```
public List<StravaAthlete> listAllAuthenticatedAthleteFriends()
```
    Description copied from interface: AthleteService
    
    Convenience method for returning ALL of the authenticated athlete's friends
    
    Returns ALL the authenticated athlete's friends, regardless of how many there are
    
    Pagination is NOT supported.
    
    USE WITH CAUTION - ATHLETES WITH MANY FRIENDS WILL REQUIRE MANY CALLS TO THE STRAVA API
    
    URL GET https://www.strava.com/api/v3/athletes/friends
    
    Specified by:
    
    listAllAuthenticatedAthleteFriends in interface AthleteService
    
    Returns:
    
    List of the authenticated athlete's friends
    
    See Also:
    
    AthleteService.listAllAuthenticatedAthleteFriends()
  - listAllAthleteKOMs
```
public List<StravaSegmentEffort> listAllAthleteKOMs(Integer athleteId)
```
    Description copied from interface: AthleteService
    
    Convenience method for returning ALL of an athlete's KOM's
    
    Returns ALL the athlete's KOM's, regardless of how many there are
    
    Pagination is NOT supported.
    
    Returns null if athlete with the given id is not found.
    
    USE WITH CAUTION - ATHLETES WITH MANY KOMS WILL REQUIRE MANY CALLS TO THE STRAVA API
    
    URL GET https://www.strava.com/api/v3/athletes/:id/koms
    
    Specified by:
    
    listAllAthleteKOMs in interface AthleteService
    
    Parameters:
    
    athleteId - The athlete whose KOM'ss are to be listed
    
    Returns:
    
    List of segment efforts for which the athlete is KOM, or null if the athlete does not exist
    
    See Also:
    
    AthleteService.listAllAthleteKOMs(java.lang.Integer)
  - listAllAthletesBothFollowing
```
public List<StravaAthlete> listAllAthletesBothFollowing(Integer athleteId)
```
    Description copied from interface: AthleteService
    
    Convenience method for returning ALL of the athletes that both the authenticated athlete and the given athlete are following
    
    Returns ALL the followers, regardless of how many there are
    
    Pagination is NOT supported.
    
    USE WITH CAUTION - ATHLETES WITH MANY FRIENDS WILL REQUIRE MANY CALLS TO THE STRAVA API
    
    URL GET https://www.strava.com/api/v3/athletes/:id/both-following
    
    Specified by:
    
    listAllAthletesBothFollowing in interface AthleteService
    
    Parameters:
    
    athleteId - The athlete who the list is to be generated for
    
    Returns:
    
    List of the authenticated athlete's friends
    
    See Also:
    
    AthleteService.listAllAthletesBothFollowing(java.lang.Integer)

Class AthleteServiceImpl

Field Summary

Fields inherited from class javastrava.api.v3.service.impl.StravaServiceImpl

Method Summary

Methods inherited from class javastrava.api.v3.service.impl.StravaServiceImpl

Methods inherited from class java.lang.Object

Method Detail

instance

getAuthenticatedAthlete

getAthlete

updateAuthenticatedAthlete

listAthleteKOMs

listAuthenticatedAthleteFriends

listAthleteFriends

listAthletesBothFollowing

listAthleteKOMs

listAuthenticatedAthleteFriends

listAthleteFriends

listAthletesBothFollowing

statistics

listAllAthleteFriends

listAllAuthenticatedAthleteFriends

listAllAthleteKOMs

listAllAthletesBothFollowing