javastrava.api.v3.service

Interface ClubService

All Superinterfaces:

StravaService

All Known Implementing Classes:

ClubServiceImpl

public interface ClubService
extends StravaService

StravaClub related services

Clubs represent groups of athletes on Strava. They can be public or private.

Only members of private clubs can access their details.

The object is returned in summary or detailed representations.

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
StravaClub	getClub(Integer id) Retrieve details about a specific club.
StravaClubMembershipResponse	joinClub(Integer id) Join a club on behalf of the authenticated user.
StravaClubMembershipResponse	leaveClub(Integer id) Leave a club on behalf of the authenticated user.
List<StravaAthlete>	listAllClubMembers(Integer clubId) Convenience method for returning ALL of the members of a club
List<StravaActivity>	listAllRecentClubActivities(Integer clubId) Retrieve ALL the recent activities performed by member athletes of a specific club.
List<StravaClub>	listAuthenticatedAthleteClubs() Fetch an array of clubs that the currently authenticated athlete is a member of.
List<StravaAthlete>	listClubMembers(Integer id) Retrieve summary information about member athletes of a specific club.
List<StravaAthlete>	listClubMembers(Integer id, Paging pagingInstruction) Retrieve summary information about member athletes of a specific club.
List<StravaActivity>	listRecentClubActivities(Integer id) Retrieve the recent activities performed by member athletes of a specific club.
List<StravaActivity>	listRecentClubActivities(Integer id, Paging pagingInstruction) Retrieve the recent activities performed by member athletes of a specific club.

Method Detail

getClub

StravaClub getClub(Integer id)

Retrieve details about a specific club. The club must be public or the current athlete must be a member.

Returns null if club with the given id does not exist

Returns an empty club (with only the id set) if the club is private and the authenticated athlete is not a member

URL GET https://www.strava.com/api/v3/clubs/:id

Parameters:

id - The id of the StravaClub to be retrieved

Returns:

Returns a detailed club representation.

See Also:

http://strava.github.io/api/v3/clubs/#get-details

listAuthenticatedAthleteClubs

List<StravaClub> listAuthenticatedAthleteClubs()

Fetch an array of clubs that the currently authenticated athlete is a member of.

Pagination is not supported. Returns all clubs of which the athlete is a member.

URL GET https://www.strava.com/api/v3/athlete/clubs

Returns:

Returns a list of club summary representations.

See Also:

http://strava.github.io/api/v3/clubs/#get-athletes

listClubMembers

List<StravaAthlete> listClubMembers(Integer id)

Retrieve summary information about member athletes of a specific club.

Pagination is not supported. Returns only the first page of members.

Returns null if club with the given id does not exist

Returns an empty list if the club is private

URL GET https://www.strava.com/api/v3/clubs/:id/members

Parameters:

id - The id of the StravaClub whose member athletes should be returned

Returns:

Returns an array of athlete summary representations.

See Also:

http://strava.github.io/api/v3/clubs/#get-members

listClubMembers

List<StravaAthlete> listClubMembers(Integer id,
                                    Paging pagingInstruction)

Retrieve summary information about member athletes of a specific club.

Pagination is supported.

Returns null if club with the given id does not exist

Returns an empty list if the club is private

URL GET https://www.strava.com/api/v3/clubs/:id/members

Parameters:

id - The id of the StravaClub whose member athletes should be returned

pagingInstruction - (Optional) The page to be returned

Returns:

Returns an array of athlete summary representations.

See Also:

http://strava.github.io/api/v3/clubs/#get-members

listRecentClubActivities

List<StravaActivity> listRecentClubActivities(Integer id)

Retrieve the recent activities performed by member athletes of a specific club.

The authenticated athlete must be a member of the club.

Pagination is NOT supported. Returns only the first page of activities.

Returns null if club with the given id does not exist

Returns an empty list if the authorised athlete is not a member of the club

Parameters:

id - The id of the StravaClub for which recent activities are to be returned.

Returns:

Returns an array of activity summary representations.

See Also:

http://strava.github.io/api/v3/clubs/#get-activities

listRecentClubActivities

List<StravaActivity> listRecentClubActivities(Integer id,
                                              Paging pagingInstruction)

Retrieve the recent activities performed by member athletes of a specific club.

The authenticated athlete must be a member of the club.

Returns null if club with the given id does not exist

Returns an empty list if the authorised athlete is not a member of the club

Pagination is supported. However, the results are limited to the last 200 total activities by club members.

Parameters:

id - The id of the StravaClub for which recent activities are to be returned.

pagingInstruction - (Optional) The page to be returned

Returns:

Returns an array of activity summary representations.

See Also:

http://strava.github.io/api/v3/clubs/#get-activities

joinClub

StravaClubMembershipResponse joinClub(Integer id)

Join a club on behalf of the authenticated user. An access token with write permissions is required.

Parameters:

id - ID of the StravaClub to join

Returns:

Response detailing whether request was successful and whether the member is active

leaveClub

StravaClubMembershipResponse leaveClub(Integer id)

Leave a club on behalf of the authenticated user. An access token with write permissions is required.

Parameters:

id - ID of the club to join

Returns:

Response detailing whether request was successful and whether the member is active

listAllClubMembers

List<StravaAthlete> listAllClubMembers(Integer clubId)

Convenience method for returning ALL of the members of a club

Returns ALL the members, regardless of how many there are

Pagination is NOT supported.

USE WITH CAUTION - CLUBS WITH MANY MEMBERS WILL REQUIRE MANY CALLS TO THE STRAVA API

Returns null if club with the given id does not exist

Returns an empty list if the club is private

URL GET https://www.strava.com/api/v3/clubs/:id/members

Parameters:

clubId - The id of the StravaClub whose member athletes should be returned

Returns:

Returns an array of athlete summary representations.

See Also:

http://strava.github.io/api/v3/clubs/#get-members

listAllRecentClubActivities

List<StravaActivity> listAllRecentClubActivities(Integer clubId)

Retrieve ALL the recent activities performed by member athletes of a specific club.

The authenticated athlete must be a member of the club.

Returns null if club with the given id does not exist

Returns an empty list if the authorised athlete is not a member of the club

Pagination is supported. However, the results are limited to the last 200 total activities by club members.

Parameters:

clubId - The id of the StravaClub for which recent activities are to be returned.

Returns:

Returns an array of activity summary representations.

See Also:

http://strava.github.io/api/v3/clubs/#get-activities