Show / Hide Table of Contents

Class CompetitionResource

Events and competitions

Inheritance
System.Object
Hawf.ApiRequestBuilder<CompetitionResource>
Hawf.Client.ApiBase<CompetitionResource>
TrackmaniaIo.ApiClient.Resources.TmIoApiBase<CompetitionResource>
CompetitionResource
Namespace: TrackmaniaIo.ApiClient.Resources
Assembly: TrackmaniaIo.ApiClient.dll
Syntax
public class CompetitionResource : TmIoApiBase<CompetitionResource>

Constructors

| Improve this Doc View Source

CompetitionResource(String, String, String)

Declaration
public CompetitionResource(string projectName, string contact, string apiKey = null)
Parameters
Type Name Description
System.String projectName
System.String contact
System.String apiKey

Methods

| Improve this Doc View Source

GetChallengeInfo(Int32, Int32)

Get information about a challenge within a competition.

Declaration
public Task<TmIoCompetitionChallengeInfo> GetChallengeInfo(int compId, int challengeId)
Parameters
Type Name Description
System.Int32 compId

ID of the competition

System.Int32 challengeId

ID of the challenge

Returns
Type Description
Task<TmIoCompetitionChallengeInfo>
| Improve this Doc View Source

GetChallengeResultsAsync(Int32, Int32, Int32)

Get results of a challenge within a competition.

Declaration
public Task<TmIoCompetitionResult> GetChallengeResultsAsync(int compId, int challengeId, int offset = 0)
Parameters
Type Name Description
System.Int32 compId

Id of the competition

System.Int32 challengeId

Id of the challenge

System.Int32 offset

Offset from position 0 in the results

Returns
Type Description
Task<TmIoCompetitionResult>
| Improve this Doc View Source

GetCompetitionAsync(Int32)

Get info about a competition.

Declaration
public Task<TmIoCompetitionInfo> GetCompetitionAsync(int id)
Parameters
Type Name Description
System.Int32 id

ID of the competition.

Returns
Type Description
Task<TmIoCompetitionInfo>
| Improve this Doc View Source

GetCompetitionListAsync()

Get a list of current events/competitions.

Declaration
public Task<TmIoCompetitionList> GetCompetitionListAsync()
Returns
Type Description
Task<TmIoCompetitionList>
| Improve this Doc View Source

GetMatchResultsAsync(Int32, Int32, Int32)

Get match results of a competition.

Declaration
public Task<TmIoCompetitionResult> GetMatchResultsAsync(int compId, int matchId, int offset = 0)
Parameters
Type Name Description
System.Int32 compId

ID of the competition

System.Int32 matchId

ID of the match

System.Int32 offset

Offset from position 0 in the results

Returns
Type Description
Task<TmIoCompetitionResult>
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾