javastrava.api.v3.service

Interface StreamService

All Superinterfaces:

StravaService

All Known Implementing Classes:

Strava, StreamServiceImpl

public interface StreamService
extends StravaService

Streams is the Strava term for the raw data associated with an activity. All streams for a given activity or segment effort will be the same length and the values at a given index correspond to the same time.

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
List<StravaStream>	getActivityStreams(Integer activityId) Streams represent the raw data of the uploaded file.
List<StravaStream>	getActivityStreams(Integer activityId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) Streams represent the raw data of the uploaded file.
CompletableFuture<List<StravaStream>>	getActivityStreamsAsync(Integer activityId) Streams represent the raw data of the uploaded file.
CompletableFuture<List<StravaStream>>	getActivityStreamsAsync(Integer activityId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) Streams represent the raw data of the uploaded file.
List<StravaStream>	getEffortStreams(Long effortId) A segment effort represents an attempt on a segment.
List<StravaStream>	getEffortStreams(Long effortId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) A segment effort represents an attempt on a segment.
CompletableFuture<List<StravaStream>>	getEffortStreamsAsync(Long effortId) A segment effort represents an attempt on a segment.
CompletableFuture<List<StravaStream>>	getEffortStreamsAsync(Long effortId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) A segment effort represents an attempt on a segment.
List<StravaStream>	getSegmentStreams(Integer segmentId) Retrieve detailed geographical information streams about a specific StravaSegment.
List<StravaStream>	getSegmentStreams(Integer segmentId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) Retrieve detailed geographical information streams about a specific StravaSegment.
CompletableFuture<List<StravaStream>>	getSegmentStreamsAsync(Integer segmentId) Retrieve detailed geographical information streams about a specific StravaSegment.
CompletableFuture<List<StravaStream>>	getSegmentStreamsAsync(Integer segmentId, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType, StravaStreamType... types) Retrieve detailed geographical information streams about a specific StravaSegment.

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

clearCache

Method Detail

getActivityStreams

List<StravaStream> getActivityStreams(Integer activityId)

Streams represent the raw data of the uploaded file. External applications may only access this information for activities owned by the authenticated athlete.

While there are a large number of stream types, they may not exist for all activities. If a stream type does not exist for the activity, it will be ignored.

All streams for a given activity will be the same length and the values at a given index correspond to the same time. For example, the time from the time stream can be correlated to the lat/lng or watts streams.

Privacy Zones

StravaStream requests made using a public access_token will be cropped with the user's privacy zones, regardless if the requesting athlete owns the requested activity. To fetch the complete stream data use an access_token with view_private permissions.

URL GET https://www.strava.com/api/v3/activities/:id/streams/:types

Parameters:

activityId - The id of the activity for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects, or null if the activity doesn't exist

Throws:

UnauthorizedException - If there is a security exception

See Also:

http://strava.github.io/api/v3/streams/#activity

getActivityStreams

List<StravaStream> getActivityStreams(Integer activityId,
                                      StravaStreamResolutionType resolution,
                                      StravaStreamSeriesDownsamplingType seriesType,
                                      StravaStreamType... types)

Streams represent the raw data of the uploaded file. External applications may only access this information for activities owned by the authenticated athlete.

While there are a large number of stream types, they may not exist for all activities. If a stream type does not exist for the activity, it will be ignored.

All streams for a given activity will be the same length and the values at a given index correspond to the same time. For example, the time from the time stream can be correlated to the lat/lng or watts streams.

Privacy Zones

StravaStream requests made using a public access_token will be cropped with the user's privacy zones, regardless if the requesting athlete owns the requested activity. To fetch the complete stream data use an access_token with view_private permissions.

URL GET https://www.strava.com/api/v3/activities/:id/streams/:types

Parameters:

activityId - The id of the activity for which streams are to be retrieved

types - List of types, if the activity does not have that stream it will not be included in the response

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

Returns:

Returns an array of unordered stream objects, or null if the activity doesn't exist

Throws:

UnauthorizedException - If there is a security exception

See Also:

http://strava.github.io/api/v3/streams/#activity

getActivityStreamsAsync

CompletableFuture<List<StravaStream>> getActivityStreamsAsync(Integer activityId)

Streams represent the raw data of the uploaded file. External applications may only access this information for activities owned by the authenticated athlete.

While there are a large number of stream types, they may not exist for all activities. If a stream type does not exist for the activity, it will be ignored.

All streams for a given activity will be the same length and the values at a given index correspond to the same time. For example, the time from the time stream can be correlated to the lat/lng or watts streams.

Privacy Zones

StravaStream requests made using a public access_token will be cropped with the user's privacy zones, regardless if the requesting athlete owns the requested activity. To fetch the complete stream data use an access_token with view_private permissions.

URL GET https://www.strava.com/api/v3/activities/:id/streams/:types

Parameters:

activityId - The id of the activity for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects, or null if the activity doesn't exist

Throws:

UnauthorizedException - If there is a security exception

See Also:

http://strava.github.io/api/v3/streams/#activity

getActivityStreamsAsync

CompletableFuture<List<StravaStream>> getActivityStreamsAsync(Integer activityId,
                                                              StravaStreamResolutionType resolution,
                                                              StravaStreamSeriesDownsamplingType seriesType,
                                                              StravaStreamType... types)

Streams represent the raw data of the uploaded file. External applications may only access this information for activities owned by the authenticated athlete.

While there are a large number of stream types, they may not exist for all activities. If a stream type does not exist for the activity, it will be ignored.

All streams for a given activity will be the same length and the values at a given index correspond to the same time. For example, the time from the time stream can be correlated to the lat/lng or watts streams.

Privacy Zones

StravaStream requests made using a public access_token will be cropped with the user's privacy zones, regardless if the requesting athlete owns the requested activity. To fetch the complete stream data use an access_token with view_private permissions.

URL GET https://www.strava.com/api/v3/activities/:id/streams/:types

Parameters:

activityId - The id of the activity for which streams are to be retrieved

types - List of types, if the activity does not have that stream it will not be included in the response

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

Returns:

Returns an array of unordered stream objects, or null if the activity doesn't exist

Throws:

UnauthorizedException - If there is a security exception

See Also:

http://strava.github.io/api/v3/streams/#activity

getEffortStreams

List<StravaStream> getEffortStreams(Long effortId)

A segment effort represents an attempt on a segment. This resource returns a subset of the activity streams that correspond to that effort.

All streams for a given segment effort will be the same length and the values at a given index correspond to the same time.

This resource is available for all public efforts.

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

Parameters:

effortId - The id of the segment effort for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects.

See Also:

http://strava.github.io/api/v3/streams/#effort

getEffortStreams

List<StravaStream> getEffortStreams(Long effortId,
                                    StravaStreamResolutionType resolution,
                                    StravaStreamSeriesDownsamplingType seriesType,
                                    StravaStreamType... types)

A segment effort represents an attempt on a segment. This resource returns a subset of the activity streams that correspond to that effort.

All streams for a given segment effort will be the same length and the values at a given index correspond to the same time.

This resource is available for all public efforts.

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

Parameters:

effortId - The id of the segment effort for which streams are to be retrieved

types - List of types, if the effort does not have that stream it will not be included in the response

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

Returns:

Returns an array of unordered stream objects.

See Also:

http://strava.github.io/api/v3/streams/#effort

getEffortStreamsAsync

CompletableFuture<List<StravaStream>> getEffortStreamsAsync(Long effortId)

A segment effort represents an attempt on a segment. This resource returns a subset of the activity streams that correspond to that effort.

All streams for a given segment effort will be the same length and the values at a given index correspond to the same time.

This resource is available for all public efforts.

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

Parameters:

effortId - The id of the segment effort for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects.

See Also:

http://strava.github.io/api/v3/streams/#effort

getEffortStreamsAsync

CompletableFuture<List<StravaStream>> getEffortStreamsAsync(Long effortId,
                                                            StravaStreamResolutionType resolution,
                                                            StravaStreamSeriesDownsamplingType seriesType,
                                                            StravaStreamType... types)

A segment effort represents an attempt on a segment. This resource returns a subset of the activity streams that correspond to that effort.

All streams for a given segment effort will be the same length and the values at a given index correspond to the same time.

This resource is available for all public efforts.

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

Parameters:

effortId - The id of the segment effort for which streams are to be retrieved

types - List of types, if the effort does not have that stream it will not be included in the response

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

Returns:

Returns an array of unordered stream objects.

See Also:

http://strava.github.io/api/v3/streams/#effort

getSegmentStreams

List<StravaStream> getSegmentStreams(Integer segmentId)

Retrieve detailed geographical information streams about a specific StravaSegment.

Only distance, altitude and latlng stream types are available.

URL GET https://www.strava.com/api/v3/segments/:id/streams/:types

Parameters:

segmentId - The id of the segment for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects.

See Also:

http://strava.github.io/api/v3/streams/#segment

getSegmentStreams

List<StravaStream> getSegmentStreams(Integer segmentId,
                                     StravaStreamResolutionType resolution,
                                     StravaStreamSeriesDownsamplingType seriesType,
                                     StravaStreamType... types)

Retrieve detailed geographical information streams about a specific StravaSegment.

Only distance, altitude and latlng stream types are available.

URL GET https://www.strava.com/api/v3/segments/:id/streams/:types

Parameters:

segmentId - The id of the segment for which streams are to be retrieved

types - List of types, if the segment does not have that stream it will not be included in the response

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

Returns:

Returns an array of unordered stream objects.

See Also:

http://strava.github.io/api/v3/streams/#segment

getSegmentStreamsAsync

CompletableFuture<List<StravaStream>> getSegmentStreamsAsync(Integer segmentId)

Retrieve detailed geographical information streams about a specific StravaSegment.

Only distance, altitude and latlng stream types are available.

URL GET https://www.strava.com/api/v3/segments/:id/streams/:types

Parameters:

segmentId - The id of the segment for which streams are to be retrieved

Returns:

Returns an array of unordered stream objects.

See Also:

http://strava.github.io/api/v3/streams/#segment

getSegmentStreamsAsync

CompletableFuture<List<StravaStream>> getSegmentStreamsAsync(Integer segmentId,
                                                             StravaStreamResolutionType resolution,
                                                             StravaStreamSeriesDownsamplingType seriesType,
                                                             StravaStreamType... types)

Retrieve detailed geographical information streams about a specific StravaSegment.

Only distance, altitude and latlng stream types are available.

URL GET https://www.strava.com/api/v3/segments/:id/streams/:types

Parameters:

segmentId - The id of the segment for which streams are to be retrieved

types - List of types, if the segment does not have that stream it will not be included in the response

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

Returns:

Returns an array of unordered stream objects.

See Also:

http://strava.github.io/api/v3/streams/#segment