javastrava.api.v3.service

Interface SegmentEffortService

All Superinterfaces:

StravaService

All Known Implementing Classes:

SegmentEffortServiceImpl, Strava

public interface SegmentEffortService
extends StravaService

A segment effort represents an athlete's attempt at a segment.

It can also be thought of as a portion of a ride that covers a segment.

The object is returned in summary or detailed representations. They are currently the same.

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
StravaSegmentEffort	getSegmentEffort(Long segmentEffortId) Retrieve details about a specific segment effort.
CompletableFuture<StravaSegmentEffort>	getSegmentEffortAsync(Long segmentEffortId) Retrieve details about a specific segment effort.

Methods inherited from interface javastrava.api.v3.service.StravaService

clearCache

Method Detail

getSegmentEffort

StravaSegmentEffort getSegmentEffort(Long segmentEffortId)

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

Parameters:

segmentEffortId - The id of the segment to be retrieved

Returns:

Returns a detailed segment effort representation

See Also:

http://strava.github.io/api/v3/efforts/#retrieve

getSegmentEffortAsync

CompletableFuture<StravaSegmentEffort> getSegmentEffortAsync(Long segmentEffortId)

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

Parameters:

segmentEffortId - The id of the segment to be retrieved

Returns:

Returns a detailed segment effort representation

See Also:

http://strava.github.io/api/v3/efforts/#retrieve