Class LeaderboardResource

Campaigns, maps and general leaderboards

Inheritance

System.Object

Hawf.ApiRequestBuilder<LeaderboardResource>

Hawf.Client.ApiBase<LeaderboardResource>

TrackmaniaIo.ApiClient.Resources.TmIoApiBase<LeaderboardResource>

LeaderboardResource

Namespace: TrackmaniaIo.ApiClient.Resources

Assembly: TrackmaniaIo.ApiClient.dll

Syntax

public class LeaderboardResource : TmIoApiBase<LeaderboardResource>

Constructors

LeaderboardResource(String, String, String)

Declaration

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

Parameters

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

Methods

GetLeaderboardAsync(String, Int64, Int64)

Get the leaderboard info of a leaderboard.

Declaration

public Task<TmIoLeaderboardInfo> GetLeaderboardAsync(string uid, long offset = 0L, long length = 10L)

Parameters

Type	Name	Description
System.String	uid	UID of the leaderboard
System.Int64	offset	Offset from position 1 in the leaderboard to get records from.
System.Int64	length	Number of records to return.

Returns

Type	Description
Task<TmIoLeaderboardInfo>

GetLeaderboardGroupAsync(String, String, Int64, Int64)

Get leaderboard positions of a leaderboard group of a certain map.

Declaration

public Task<TmIoLeaderboardInfo> GetLeaderboardGroupAsync(string group, string uid, long offset = 0L, long length = 15L)

Parameters

Type	Name	Description
System.String	group	ID of the leaderboard group.
System.String	uid	UID of the map.
System.Int64	offset	Offset from position 1 in the leaderboard to get records from
System.Int64	length	Number of records to return.

Returns

Type	Description
Task<TmIoLeaderboardInfo>