Class CotdResource

Cup of the day info and leaderboards

Inheritance

System.Object

Hawf.ApiRequestBuilder<CotdResource>

Hawf.Client.ApiBase<CotdResource>

TrackmaniaIo.ApiClient.Resources.TmIoApiBase<CotdResource>

CotdResource

Namespace: TrackmaniaIo.ApiClient.Resources

Assembly: TrackmaniaIo.ApiClient.dll

Syntax

public class CotdResource : TmIoApiBase<CotdResource>

Constructors

CotdResource(String, String, String)

Declaration

public CotdResource(string projectName, string contact, string apiKey = null)

Parameters

Type	Name	Description
System.String	projectName
System.String	contact
System.String	apiKey

Methods

GetCotdListAsync(Int32)

Get a list of latest COTD competitions.

Declaration

public Task<TmIoCotdCompetitionList> GetCotdListAsync(int offset = 0)

Parameters

Type	Name	Description
System.Int32	offset	Offset from latest COTD to get the list from

Returns

Type	Description
Task<TmIoCotdCompetitionList>

GetTotalPlayedLeaderboardAsync(Boolean, Int32)

Get the total played leaderboard.

Declaration

public Task<TmIoCotdLeaderboard> GetTotalPlayedLeaderboardAsync(bool includeReruns = false, int offset = 0)

Parameters

Type	Name	Description
System.Boolean	includeReruns	Whether to include cotd re-runs
System.Int32	offset	Offset from position 0

Returns

Type	Description
Task<TmIoCotdLeaderboard>

GetWinsLeaderboardAsync(Boolean, Int32)

Get the wins leaderboard.

Declaration

public Task<TmIoCotdLeaderboard> GetWinsLeaderboardAsync(bool includeReruns = false, int offset = 0)

Parameters

Type	Name	Description
System.Boolean	includeReruns	Whether to include cotd re-runs
System.Int32	offset	Offset from position 0

Returns

Type	Description
Task<TmIoCotdLeaderboard>

GetWinStreakLeaderboardAsync(Boolean, Int32)

Get the win-streak leaderboard.

Declaration

public Task<TmIoCotdLeaderboard> GetWinStreakLeaderboardAsync(bool includeReruns = false, int offset = 0)

Parameters

Type	Name	Description
System.Boolean	includeReruns	Whether to include cotd re-runs
System.Int32	offset	Offset from position 0

Returns

Type	Description
Task<TmIoCotdLeaderboard>