Strava v1.0.0 Strava.Streams View Source
API calls for all endpoints tagged Streams.
Link to this section Summary
Functions
Get Activity Streams Returns the given activity's streams. Requires activity:read scope. Requires activity:read_all scope for Only Me activities
Get segment effort streams Returns a set of streams for a segment effort completed by the authenticated athlete. Requires read_all scope
Get Segment Streams Returns the given segment's streams. Requires read_all scope for private segments
Link to this section Functions
get_activity_streams(client, id, keys, key_by_type, opts \\ [])
View Source
get_activity_streams(
Tesla.Env.client(),
integer(),
[String.t()],
boolean(),
keyword()
) :: {:ok, Strava.StreamSet.t()} | {:error, Tesla.Env.t()}
get_activity_streams( Tesla.Env.client(), integer(), [String.t()], boolean(), keyword() ) :: {:ok, Strava.StreamSet.t()} | {:error, Tesla.Env.t()}
Get Activity Streams Returns the given activity's streams. Requires activity:read scope. Requires activity:read_all scope for Only Me activities.
Parameters
- client (Strava.Client): Client to make authenticated requests
- id (integer()): The identifier of the activity.
- keys ([String.t]): Desired stream types.
- key_by_type (boolean()): Must be true.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Strava.StreamSet{}} on success {:error, info} on failure
get_segment_effort_streams(client, id, keys, key_by_type, opts \\ [])
View Source
get_segment_effort_streams(
Tesla.Env.client(),
integer(),
[String.t()],
boolean(),
keyword()
) :: {:ok, Strava.StreamSet.t()} | {:error, Tesla.Env.t()}
get_segment_effort_streams( Tesla.Env.client(), integer(), [String.t()], boolean(), keyword() ) :: {:ok, Strava.StreamSet.t()} | {:error, Tesla.Env.t()}
Get segment effort streams Returns a set of streams for a segment effort completed by the authenticated athlete. Requires read_all scope.
Parameters
- client (Strava.Client): Client to make authenticated requests
- id (integer()): The identifier of the segment effort.
- keys ([String.t]): The types of streams to return.
- key_by_type (boolean()): Must be true.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Strava.StreamSet{}} on success {:error, info} on failure
get_segment_streams(client, id, keys, key_by_type, opts \\ [])
View Source
get_segment_streams(
Tesla.Env.client(),
integer(),
[String.t()],
boolean(),
keyword()
) :: {:ok, Strava.StreamSet.t()} | {:error, Tesla.Env.t()}
get_segment_streams( Tesla.Env.client(), integer(), [String.t()], boolean(), keyword() ) :: {:ok, Strava.StreamSet.t()} | {:error, Tesla.Env.t()}
Get Segment Streams Returns the given segment's streams. Requires read_all scope for private segments.
Parameters
- client (Strava.Client): Client to make authenticated requests
- id (integer()): The identifier of the segment.
- keys ([String.t]): The types of streams to return.
- key_by_type (boolean()): Must be true.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Strava.StreamSet{}} on success {:error, info} on failure