Interface IClubsApi

Namespace

Tudormobile.Strava.Api

Assembly

Tudormobile.Strava.dll

Strava V3 Clubs API Interface.

public interface IClubsApi : IStravaApi

Inherited Members

IStravaApi.GetStreamAsync(string, CancellationToken)

IStravaApi.GetAthleteAsync(long?, CancellationToken)

IStravaApi.GetApiResultAsync<T>(Uri, CancellationToken)

IStravaApi.PutApiResultAsync<TBody, TResult>(Uri, TBody, CancellationToken)

IStravaApi.GetApiResultAsync<T>(string, CancellationToken)

IStravaApi.PutApiResultAsync<TBody, TResult>(string, TBody, CancellationToken)

IStravaApi.PostApiResultAsync<TResult>(Uri, HttpContent, CancellationToken)

IStravaApi.PostApiResultAsync<TResult>(string, HttpContent, CancellationToken)

Methods

GetClubAsync(long, CancellationToken)

Returns a given a club using its identifier.

Task<ApiResult<DetailedClub>> GetClubAsync(long id, CancellationToken cancellationToken = default)

Parameters

id long

The identifier of the club.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ApiResult<DetailedClub>>

The club's detailed representation. An instance of DetailedClub.

ListAthleteClubsAsync(int?, int?, CancellationToken)

Returns the clubs that the currently authenticated athlete is a member of.

Task<ApiResult<List<SummaryClub>>> ListAthleteClubsAsync(int? page = null, int? perPage = null, CancellationToken cancellationToken = default)

Parameters

page int?

Page number (optional).

perPage int?

Number of items per page (optional).

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ApiResult<List<SummaryClub>>>

A list of clubs. An instance of ApiResult<T> where T is List<T>.

ListClubActivitiesAsync(long, int?, int?, CancellationToken)

Returns the activities of a given club using its identifier.

Task<ApiResult<List<ClubActivity>>> ListClubActivitiesAsync(long id, int? page = null, int? perPage = null, CancellationToken cancellationToken = default)

Parameters

id long

The identifier of the club.

page int?

Page number (optional).

perPage int?

Number of items per page (optional).

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ApiResult<List<ClubActivity>>>

A list of club activities. An instance of ApiResult<T> where T is List<T>.

ListClubAdministratorsAsync(long, int?, int?, CancellationToken)

Returns the administrators of a given club using its identifier.

Task<ApiResult<List<SummaryAthlete>>> ListClubAdministratorsAsync(long id, int? page = null, int? perPage = null, CancellationToken cancellationToken = default)

Parameters

id long

The identifier of the club.

page int?

Page number (optional).

perPage int?

Number of items per page (optional).

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ApiResult<List<SummaryAthlete>>>

A list of club administrators. An instance of ApiResult<T> where T is List<T>.

ListClubMembersAsync(long, int?, int?, CancellationToken)

Returns the athletes of a given club using its identifier.

Task<ApiResult<List<ClubAthlete>>> ListClubMembersAsync(long id, int? page = null, int? perPage = null, CancellationToken cancellationToken = default)

Parameters

id long

The identifier of the club.

page int?

Page number (optional).

perPage int?

Number of items per page (optional).

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ApiResult<List<ClubAthlete>>>

A list of club athletes. An instance of ApiResult<T> where T is List<T>.