Strava v0.4.0 Strava.Club View Source

Clubs represent groups of athletes on Strava.

More info: https://strava.github.io/api/v3/clubs/

Link to this section Summary

Functions

Retrieve the recent activities performed by members of a specific club. The authenticated athlete must be a member of the club

Retrieve summary information about members of a specific club. Pagination is supported

Retrieve details about a specific club. The club must be public or the current athlete must be a member

Link to this section Types

Link to this type t() View Source
t() :: %Strava.Club{admin: boolean, city: String.t, club_type: String.t, country: String.t, cover_photo: String.t, cover_photo_small: String.t, description: String.t, featured: boolean, following_count: integer, id: integer, member_count: integer, membership: String.t, name: String.t, owner: boolean, private: boolean, profile: String.t, profile_medium: String.t, resource_state: integer, sport_type: String.t, state: String.t, url: String.t, verified: boolean}

Link to this section Functions

Link to this function list_activities(id, pagination, client \\ Strava.Client.new()) View Source
list_activities(integer, Strava.Pagination.t, Strava.Client.t) :: [Strava.Activity.t]

Retrieve the recent activities performed by members of a specific club. The authenticated athlete must be a member of the club.

Example

club = Strava.Club.listactivities(1, %Strava.Pagination{perpage: 200, page: 1}) club = Strava.Club.listactivities(1, %Strava.Pagination{perpage: 200, page: 1}, Strava.Client.new(">"))

More info: http://strava.github.io/api/v3/clubs/#get-activities

Link to this function list_members(id, pagination, client \\ Strava.Client.new()) View Source

Retrieve summary information about members of a specific club. Pagination is supported.

Example

members = Strava.Club.list_members(1, %Strava.Pagination{per_page: 200, page: 1})
members = Strava.Club.list_members(1, %Strava.Pagination{per_page: 200, page: 1}, Strava.Client.new("<access_token>>"))

More info: http://strava.github.io/api/v3/clubs/#get-members

Link to this function retrieve(id, client \\ Strava.Client.new()) View Source
retrieve(integer, Strava.Client.t) :: Strava.Club.t

Retrieve details about a specific club. The club must be public or the current athlete must be a member.

Example

club = Strava.Club.retrieve(1)
club = Strava.Club.retrieve(1, Strava.Client.new("<access_token>>"))

More info: https://strava.github.io/api/v3/clubs/#get-details

Link to this function stream_members(id, client \\ Strava.Client.new()) View Source
stream_members(integer, Strava.Client.t) :: Enumerable.t