javastrava.api.v3.rest

Interface ClubAPI

public interface ClubAPI

API definition of the endpoints for club services

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
StravaClub	getClub(Integer clubId)
void	getClub(Integer clubId, StravaAPICallback<StravaClub> callback)
StravaClubMembershipResponse	joinClub(Integer clubId)
void	joinClub(Integer clubId, StravaAPICallback<StravaClubMembershipResponse> callback)
StravaClubMembershipResponse	leaveClub(Integer clubId)
void	leaveClub(Integer clubId, StravaAPICallback<StravaClubMembershipResponse> callback)
StravaClub[]	listAuthenticatedAthleteClubs()
void	listAuthenticatedAthleteClubs(StravaAPICallback<StravaClub[]> callback)
StravaAthlete[]	listClubAdmins(Integer clubId, Integer page, Integer perPage) Retrieve summary information about admins of a specific club, with the owner on top and sorted by first names.
void	listClubAdmins(Integer clubId, Integer page, Integer perPage, StravaAPICallback<StravaAthlete[]> callback) Retrieve summary information about admins of a specific club, with the owner on top and sorted by first names.
StravaClubAnnouncement[]	listClubAnnouncements(Integer clubId)
void	listClubAnnouncements(Integer clubId, StravaAPICallback<StravaClubAnnouncement[]> callback)
StravaClubEvent[]	listClubGroupEvents(Integer clubId)
void	listClubGroupEvents(Integer clubId, StravaAPICallback<StravaClubEvent[]> callback)
StravaAthlete[]	listClubMembers(Integer clubId, Integer page, Integer perPage)
void	listClubMembers(Integer clubId, Integer page, Integer perPage, StravaAPICallback<StravaAthlete[]> callback)
StravaActivity[]	listRecentClubActivities(Integer clubId, Integer page, Integer perPage)
void	listRecentClubActivities(Integer clubId, Integer page, Integer perPage, StravaAPICallback<StravaActivity[]> callback)

Method Detail

getClub

@GET(value="/clubs/{id}")
StravaClub getClub(@Path(value="id")
                                              Integer clubId)
                                       throws NotFoundException

Parameters:

clubId - Club identifier

Returns:

Club details

Throws:

NotFoundException - If the club with the given id doesn't exist

See Also:

ClubService.getClub(java.lang.Integer)

getClub

@GET(value="/clubs/{id}")
void getClub(@Path(value="id")
                                        Integer clubId,
                                        StravaAPICallback<StravaClub> callback)
                                 throws NotFoundException

Parameters:

clubId - Club identifier

callback - The callback to execute on completion

Throws:

NotFoundException - If the club with the given id doesn't exist

See Also:

ClubService.getClub(java.lang.Integer)

joinClub

@POST(value="/clubs/{id}/join")
StravaClubMembershipResponse joinClub(@Path(value="id")
                                                                       Integer clubId)
                                                                throws NotFoundException

Parameters:

clubId - The club the authenticated athlete wishes to join

Returns:

Membership response indicating success/failure

Throws:

NotFoundException - If the club with the given id doesn't exist

See Also:

ClubService.joinClub(java.lang.Integer)

joinClub

@POST(value="/clubs/{id}/join")
void joinClub(@Path(value="id")
                                               Integer clubId,
                                               StravaAPICallback<StravaClubMembershipResponse> callback)
                                        throws NotFoundException

Parameters:

clubId - The club the authenticated athlete wishes to join

callback - The callback to execute on completion

Throws:

NotFoundException - If the club with the given id doesn't exist

See Also:

ClubService.joinClub(java.lang.Integer)

leaveClub

@POST(value="/clubs/{id}/leave")
StravaClubMembershipResponse leaveClub(@Path(value="id")
                                                                         Integer clubId)
                                                                  throws NotFoundException

Parameters:

clubId - The club the authenticated athlete wishes to leave

Returns:

Membership response indicating success/failure

Throws:

NotFoundException - If the club with the given id doesn't exist

See Also:

ClubService.leaveClub(java.lang.Integer)

leaveClub

@POST(value="/clubs/{id}/leave")
void leaveClub(@Path(value="id")
                                                 Integer clubId,
                                                 StravaAPICallback<StravaClubMembershipResponse> callback)
                                          throws NotFoundException

Parameters:

clubId - The club the authenticated athlete wishes to leave

callback - The callback to execute on completion

Throws:

NotFoundException - If the club with the given id doesn't exist

See Also:

ClubService.leaveClub(java.lang.Integer)

listAuthenticatedAthleteClubs

@GET(value="/athlete/clubs")
StravaClub[] listAuthenticatedAthleteClubs()

Returns:

Array of clubs that the authenticated athlete belongs to

See Also:

ClubService.listAuthenticatedAthleteClubs()

listAuthenticatedAthleteClubs

@GET(value="/athlete/clubs")
void listAuthenticatedAthleteClubs(StravaAPICallback<StravaClub[]> callback)

Parameters:

callback - The callback to execute on completion

See Also:

ClubService.listAuthenticatedAthleteClubs()

listClubAdmins

@GET(value="/clubs/{id}/admins")
StravaAthlete[] listClubAdmins(@Path(value="id")
                                                                 Integer clubId,
                                                                 @Query(value="page")
                                                                 Integer page,
                                                                 @Query(value="per_page")
                                                                 Integer perPage)
                                                          throws NotFoundException

Retrieve summary information about admins of a specific club, with the owner on top and sorted by first names. Pagination is supported.

Parameters:

clubId - The club for which to list admins

page - Page number to be returned (default is 1)

perPage - Page size to be returned (default is 50)

Returns:

Array of StravaAthletes

Throws:

NotFoundException - if club id is invalid

listClubAdmins

@GET(value="/clubs/{id}/admins")
void listClubAdmins(@Path(value="id")
                                                      Integer clubId,
                                                      @Query(value="page")
                                                      Integer page,
                                                      @Query(value="per_page")
                                                      Integer perPage,
                                                      StravaAPICallback<StravaAthlete[]> callback)
                                               throws NotFoundException

Retrieve summary information about admins of a specific club, with the owner on top and sorted by first names. Pagination is supported.

Parameters:

clubId - The club for which to list admins

page - Page number to be returned (default is 1)

perPage - Page size to be returned (default is 50)

callback - Callback used to return the athletes

Throws:

NotFoundException - if club id is invalid

listClubAnnouncements

@GET(value="/clubs/{id}/announcements")
StravaClubAnnouncement[] listClubAnnouncements(@Path(value="id")
                                                                                        Integer clubId)
                                                                                 throws NotFoundException

Parameters:

clubId - The club for which to list announcements

Returns:

Array of StravaClubAnnouncements

Throws:

NotFoundException - If the club does not exist

listClubAnnouncements

@GET(value="/clubs/{id}/announcements")
void listClubAnnouncements(@Path(value="id")
                                                                    Integer clubId,
                                                                    StravaAPICallback<StravaClubAnnouncement[]> callback)
                                                             throws NotFoundException

Parameters:

clubId - The club for which to list announcements

callback - The callback to execute on completion

Throws:

NotFoundException - If the club does not exist

listClubGroupEvents

@GET(value="/clubs/{id}/group_events")
StravaClubEvent[] listClubGroupEvents(@Path(value="id")
                                                                              Integer clubId)

Parameters:

clubId - Unique id of the club whose events should be listed

Returns:

Array of summary events

listClubGroupEvents

@GET(value="/clubs/{id}/group_events")
void listClubGroupEvents(@Path(value="id")
                                                                 Integer clubId,
                                                                 StravaAPICallback<StravaClubEvent[]> callback)

Parameters:

clubId - Unique id of the club whose events should be listed

callback - The callback to execute on completion

listClubMembers

@GET(value="/clubs/{id}/members")
StravaAthlete[] listClubMembers(@Path(value="id")
                                                                   Integer clubId,
                                                                   @Query(value="page")
                                                                   Integer page,
                                                                   @Query(value="per_page")
                                                                   Integer perPage)
                                                            throws NotFoundException,
                                                                   BadRequestException

Parameters:

clubId - CLub identifier

page - Page number to be returned (default is 1)

perPage - Page size to be returned (default is 50)

Returns:

Array of athletes who are members of the identified club

Throws:

NotFoundException - If the club with the given id doesn't exist

BadRequestException - If the paging instructions are invalid

See Also:

ClubService.listClubMembers(Integer, javastrava.util.Paging)

listClubMembers

@GET(value="/clubs/{id}/members")
void listClubMembers(@Path(value="id")
                                                        Integer clubId,
                                                        @Query(value="page")
                                                        Integer page,
                                                        @Query(value="per_page")
                                                        Integer perPage,
                                                        StravaAPICallback<StravaAthlete[]> callback)
                                                 throws NotFoundException,
                                                        BadRequestException

Parameters:

clubId - CLub identifier

page - Page number to be returned (default is 1)

perPage - Page size to be returned (default is 50)

callback - The callback to execute on completion

Throws:

NotFoundException - If the club with the given id doesn't exist

BadRequestException - If the paging instructions are invalid

See Also:

ClubService.listClubMembers(Integer, javastrava.util.Paging)

listRecentClubActivities

@GET(value="/clubs/{id}/activities")
StravaActivity[] listRecentClubActivities(@Path(value="id")
                                                                                Integer clubId,
                                                                                @Query(value="page")
                                                                                Integer page,
                                                                                @Query(value="per_page")
                                                                                Integer perPage)
                                                                         throws NotFoundException,
                                                                                BadRequestException

Parameters:

clubId - Club identifier

page - Page number to be returned (default is 1)

perPage - Page size to be returned (default is 50)

Returns:

Array of activities recently done by club members (maximum 200 will be returned)

Throws:

NotFoundException - If the club with the given id doesn't exist

BadRequestException - If the paging instructions are invalid

See Also:

ClubService.listRecentClubActivities(Integer, javastrava.util.Paging)

listRecentClubActivities

@GET(value="/clubs/{id}/activities")
void listRecentClubActivities(@Path(value="id")
                                                                    Integer clubId,
                                                                    @Query(value="page")
                                                                    Integer page,
                                                                    @Query(value="per_page")
                                                                    Integer perPage,
                                                                    StravaAPICallback<StravaActivity[]> callback)
                                                             throws NotFoundException,
                                                                    BadRequestException

Parameters:

clubId - Club identifier

page - Page number to be returned (default is 1)

perPage - Page size to be returned (default is 50)

callback - The callback to execute on completion

Throws:

NotFoundException - If the club with the given id doesn't exist

BadRequestException - If the paging instructions are invalid

See Also:

ClubService.listRecentClubActivities(Integer, javastrava.util.Paging)