Class PlayersResource

Player lists, info and search

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

Constructors

| Improve this Doc View Source

PlayersResource(String, String, String)

Declaration
public PlayersResource(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

GetNadeoPlayers()

Get known Nadeo players.

Declaration
public Task<TmIoPlayerSearchEntry[]> GetNadeoPlayers()
Returns
Type Description
Task<TmIoPlayerSearchEntry[]>
| Improve this Doc View Source

GetPlayer3V3MatchesAsync(String, Int32)

Get a list of recent 3V3 MM matches.

Declaration
public Task<TmIoPlayerMatchList> GetPlayer3V3MatchesAsync(string accountId, int page = 0)
Parameters
Type Name Description
System.String accountId

Account ID of the player (not uid)
System.Int32 page

Pagination number
Returns
Type Description
Task<TmIoPlayerMatchList>
| Improve this Doc View Source

GetPlayerCotdInfoAsync(String, Int32)

Get information about the player's COTD performances.

Declaration
public Task<TmIoPlayerCotdInfo> GetPlayerCotdInfoAsync(string accountId, int page = 0)
Parameters
Type Name Description
System.String accountId

Account ID of the player (not uid)
System.Int32 page

Pagination number
Returns
Type Description
Task<TmIoPlayerCotdInfo>
| Improve this Doc View Source

GetPlayerProfileAsync(String)

Get the profile of a player

Declaration
public Task<TmIoPlayerProfile> GetPlayerProfileAsync(string accountId)
Parameters
Type Name Description
System.String accountId

Account ID of the player (not uid)
Returns
Type Description
Task<TmIoPlayerProfile>
| Improve this Doc View Source

GetPlayerRoyalMatchesAsync(String, Int32)

Get a list of recent royal matches.

Declaration
public Task<TmIoPlayerMatchList> GetPlayerRoyalMatchesAsync(string accountId, int page = 0)
Parameters
Type Name Description
System.String accountId

Account ID of the player (not uid)
System.Int32 page

Pagination number
Returns
Type Description
Task<TmIoPlayerMatchList>
| Improve this Doc View Source

GetPlayerTrophyGainsAsync(String, Int32)

Get a list of recent trophy gains.

Declaration
public Task<TmIoTrophyGainList> GetPlayerTrophyGainsAsync(string accountId, int page = 0)
Parameters
Type Name Description
System.String accountId

Account ID of the player (not uid)
System.Int32 page

Pagination number
Returns
Type Description
Task<TmIoTrophyGainList>
| Improve this Doc View Source

GetSponsorPlayersAsync()

Get known players that are sponsors of openplanet and tm.io

Declaration
public Task<TmIoPlayerSearchEntry[]> GetSponsorPlayersAsync()
Returns
Type Description
Task<TmIoPlayerSearchEntry[]>
| Improve this Doc View Source

GetTmglPlayersAsync()

Get known TGML players.

Declaration
public Task<TmIoPlayerSearchEntry[]> GetTmglPlayersAsync()
Returns
Type Description
Task<TmIoPlayerSearchEntry[]>
| Improve this Doc View Source

GetTmIoTeamPlayersAsync()

Get known players that are in the team of openplanet and tm.io

Declaration
public Task<TmIoPlayerSearchEntry[]> GetTmIoTeamPlayersAsync()
Returns
Type Description
Task<TmIoPlayerSearchEntry[]>
| Improve this Doc View Source

SearchPlayersAsync(String)

Search for players by name.

Declaration
public Task<TmIoPlayerSearchEntry[]> SearchPlayersAsync(string name)
Parameters
Type Name Description
System.String name

Full or partial name of the player
Returns
Type Description
Task<TmIoPlayerSearchEntry[]>