javastrava.api.v3.service.impl

Class SegmentEffortServiceImpl

java.lang.Object

javastrava.api.v3.service.impl.StravaServiceImpl

javastrava.api.v3.service.impl.SegmentEffortServiceImpl

All Implemented Interfaces:

SegmentEffortService, StravaService

public class SegmentEffortServiceImpl
extends StravaServiceImpl
implements SegmentEffortService

Author:

Dan Shannon

Field Summary

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

api, requestRate, requestRateDaily

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clear any and all cached data entries
StravaSegmentEffort	getSegmentEffort(Long segmentEffortId) Retrieve details about a specific segment effort.
CompletableFuture<StravaSegmentEffort>	getSegmentEffortAsync(Long segmentEffortId) Retrieve details about a specific segment effort.
static SegmentEffortService	instance(Token token) Returns an instance of segment effort services

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

accessTokenIsValid, future, 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 SegmentEffortService instance(Token token)

Returns an instance of segment effort 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 segment effort services

clearCache

public void clearCache()

Description copied from interface: StravaService

Clear any and all cached data entries

Primarily used when revoking/deauthorising a token so that there are no entries remaining that are associated with the token that could mistakenly get returned

Specified by:

clearCache in interface StravaService

See Also:

StravaService.clearCache()

getSegmentEffort

public StravaSegmentEffort getSegmentEffort(Long segmentEffortId)

Description copied from interface: SegmentEffortService

Retrieve details about a specific segment effort. The effort must be public or it must correspond to the current athlete.

Returns null if the segment effort does not exist or is private

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

Specified by:

getSegmentEffort in interface SegmentEffortService

Parameters:

segmentEffortId - The id of the segment to be retrieved

Returns:

Returns a detailed segment effort representation

See Also:

SegmentEffortService.getSegmentEffort(Long)

getSegmentEffortAsync

public CompletableFuture<StravaSegmentEffort> getSegmentEffortAsync(Long segmentEffortId)

Description copied from interface: SegmentEffortService

Retrieve details about a specific segment effort. The effort must be public or it must correspond to the current athlete.

Returns null if the segment effort does not exist or is private

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

Specified by:

getSegmentEffortAsync in interface SegmentEffortService

Parameters:

segmentEffortId - The id of the segment to be retrieved

Returns:

Returns a detailed segment effort representation

See Also:

SegmentEffortService.getSegmentEffortAsync(java.lang.Long)