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.
clearCacheStravaClub getClub(Integer clubId)
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
clubId - The id of the StravaClub to be retrievedCompletableFuture<StravaClub> getClubAsync(Integer clubId)
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
clubId - The id of the StravaClub to be retrievedStravaClubMembershipResponse joinClub(Integer clubId)
Join a club on behalf of the authenticated user. An access token with write permissions is required.
clubId - ID of the StravaClub to joinCompletableFuture<StravaClubMembershipResponse> joinClubAsync(Integer clubId)
Join a club on behalf of the authenticated user. An access token with write permissions is required.
clubId - ID of the StravaClub to joinStravaClubMembershipResponse leaveClub(Integer clubId)
Leave a club on behalf of the authenticated user. An access token with write permissions is required.
clubId - ID of the club to joinCompletableFuture<StravaClubMembershipResponse> leaveClubAsync(Integer clubId)
Leave a club on behalf of the authenticated user. An access token with write permissions is required.
clubId - ID of the club to joinList<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
clubId - The id of the StravaClub whose member athletes should be returnedathlete summary representations.CompletableFuture<List<StravaAthlete>> listAllClubMembersAsync(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
clubId - The id of the StravaClub whose member athletes should be returnedathlete summary representations.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.
clubId - The id of the StravaClub for which recent activities are to be returned.activity summary representations.CompletableFuture<List<StravaActivity>> listAllRecentClubActivitiesAsync(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.
clubId - The id of the StravaClub for which recent activities are to be returned.activity summary representations.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
club summary representations.CompletableFuture<List<StravaClub>> listAuthenticatedAthleteClubsAsync()
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
club summary representations.List<StravaAthlete> listClubAdmins(Integer clubId)
CompletableFuture<List<StravaAthlete>> listClubAdminsAsync(Integer clubId)
List<StravaAthlete> listClubAdmins(Integer clubId, Paging paging)
CompletableFuture<List<StravaAthlete>> listClubAdminsAsync(Integer clubId, Paging paging)
List<StravaAthlete> listAllClubAdmins(Integer clubId)
CompletableFuture<List<StravaAthlete>> listAllClubAdminsAsync(Integer clubId)
List<StravaClubAnnouncement> listClubAnnouncements(Integer clubId)
Announcements are posts sent by Club Admins or Owners to the members of a club.
Only members of private clubs can access their announcements.
The objects are returned in summary representation.
Returns null if the club with the given id does not exist.
Returns an empty list if the club is private and the authorised athlete is not a member of the club
Pagination is not supported
clubId - The id of the StravaClub for which announcements should be returned.announcementsCompletableFuture<List<StravaClubAnnouncement>> listClubAnnouncementsAsync(Integer clubId)
Announcements are posts sent by Club Admins or Owners to the members of a club.
Only members of private clubs can access their announcements.
The objects are returned in summary representation.
Returns null if the club with the given id does not exist.
Returns an empty list if the club is private and the authorised athlete is not a member of the club
Pagination is not supported
clubId - The id of the StravaClub for which announcements should be returned.announcementsList<StravaClubEvent> listClubGroupEvents(Integer clubId)
Group Events are optionally recurring events for club members.
Only club members can access private club events.
The objects are returned in summary representation.
Pagination is NOT supported
clubId - Club identifierCompletableFuture<List<StravaClubEvent>> listClubGroupEventsAsync(Integer clubId)
Group Events are optionally recurring events for club members.
Only club members can access private club events.
The objects are returned in summary representation.
Pagination is NOT supported
clubId - Club identifierCompletableFuture.get())List<StravaAthlete> listClubMembers(Integer clubId)
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
clubId - The id of the StravaClub whose member athletes should be returnedathlete summary representations.List<StravaAthlete> listClubMembers(Integer clubId, 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
clubId - The id of the StravaClub whose member athletes should be returnedpagingInstruction - (Optional) The page to be returnedathlete summary representations.CompletableFuture<List<StravaAthlete>> listClubMembersAsync(Integer clubId)
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
clubId - The id of the StravaClub whose member athletes should be returnedathlete summary representations.CompletableFuture<List<StravaAthlete>> listClubMembersAsync(Integer clubId, 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
clubId - The id of the StravaClub whose member athletes should be returnedpagingInstruction - (Optional) The page to be returnedathlete summary representations.List<StravaActivity> listRecentClubActivities(Integer clubId)
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
clubId - The id of the StravaClub for which recent activities are to be returned.activity summary representations.List<StravaActivity> listRecentClubActivities(Integer clubId, 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.
clubId - The id of the StravaClub for which recent activities are to be returned.pagingInstruction - (Optional) The page to be returnedactivity summary representations.CompletableFuture<List<StravaActivity>> listRecentClubActivitiesAsync(Integer clubId)
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
clubId - The id of the StravaClub for which recent activities are to be returned.activity summary representations.CompletableFuture<List<StravaActivity>> listRecentClubActivitiesAsync(Integer clubId, 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.
clubId - The id of the StravaClub for which recent activities are to be returned.pagingInstruction - (Optional) The page to be returnedactivity summary representations.Copyright © 2016 Dan Shannon. All rights reserved.