Show / Hide Table of Contents

Class TftLeagueV1Endpoints

TftLeagueV1 endpoints. This class is automatically generated.

Official API Reference https://developer.riotgames.com/api-methods/#tft-league-v1

Inheritance
System.Object
Endpoints
TftLeagueV1Endpoints
Inherited Members
Endpoints.base
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Camille.RiotGames
Assembly: Camille.RiotGames.dll
Syntax
public class TftLeagueV1Endpoints : Endpoints

Methods

| Improve this Doc View Source

GetChallengerLeague(PlatformRoute, String, Nullable<CancellationToken>)

Get the challenger league. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getChallengerLeague

Declaration
public LeagueList GetChallengerLeague(PlatformRoute route, string queue = null, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String queue

Defaults to RANKED_TFT. (optional, in query)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
LeagueList
| Improve this Doc View Source

GetChallengerLeagueAsync(PlatformRoute, String, Nullable<CancellationToken>)

Get the challenger league. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getChallengerLeague

Declaration
public Task<LeagueList> GetChallengerLeagueAsync(PlatformRoute route, string queue = null, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String queue

Defaults to RANKED_TFT. (optional, in query)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
System.Threading.Tasks.Task<LeagueList>
| Improve this Doc View Source

GetGrandmasterLeague(PlatformRoute, String, Nullable<CancellationToken>)

Get the grandmaster league. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getGrandmasterLeague

Declaration
public LeagueList GetGrandmasterLeague(PlatformRoute route, string queue = null, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String queue

Defaults to RANKED_TFT. (optional, in query)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
LeagueList
| Improve this Doc View Source

GetGrandmasterLeagueAsync(PlatformRoute, String, Nullable<CancellationToken>)

Get the grandmaster league. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getGrandmasterLeague

Declaration
public Task<LeagueList> GetGrandmasterLeagueAsync(PlatformRoute route, string queue = null, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String queue

Defaults to RANKED_TFT. (optional, in query)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
System.Threading.Tasks.Task<LeagueList>
| Improve this Doc View Source

GetLeagueById(PlatformRoute, String, Nullable<CancellationToken>)

Get league with given ID, including inactive entries. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getLeagueById

Declaration
public LeagueList GetLeagueById(PlatformRoute route, string leagueId, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String leagueId

The UUID of the league. (required, in path)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
LeagueList
| Improve this Doc View Source

GetLeagueByIdAsync(PlatformRoute, String, Nullable<CancellationToken>)

Get league with given ID, including inactive entries. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getLeagueById

Declaration
public Task<LeagueList> GetLeagueByIdAsync(PlatformRoute route, string leagueId, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String leagueId

The UUID of the league. (required, in path)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
System.Threading.Tasks.Task<LeagueList>
| Improve this Doc View Source

GetLeagueEntries(PlatformRoute, Enums.Tier, String, Nullable<Int32>, String, Nullable<CancellationToken>)

Get all the league entries. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getLeagueEntries

Declaration
public LeagueEntry[] GetLeagueEntries(PlatformRoute route, Enums.Tier tier, string division, int? page = null, string queue = null, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

Tier tier

(required, in path)

System.String division

(required, in path)

System.Nullable<System.Int32> page

Defaults to 1. Starts with page 1. (optional, in query)

System.String queue

Defaults to RANKED_TFT. (optional, in query)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
LeagueEntry[]
| Improve this Doc View Source

GetLeagueEntriesAsync(PlatformRoute, Enums.Tier, String, Nullable<Int32>, String, Nullable<CancellationToken>)

Get all the league entries. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getLeagueEntries

Declaration
public Task<LeagueEntry[]> GetLeagueEntriesAsync(PlatformRoute route, Enums.Tier tier, string division, int? page = null, string queue = null, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

Tier tier

(required, in path)

System.String division

(required, in path)

System.Nullable<System.Int32> page

Defaults to 1. Starts with page 1. (optional, in query)

System.String queue

Defaults to RANKED_TFT. (optional, in query)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
System.Threading.Tasks.Task<LeagueEntry[]>
| Improve this Doc View Source

GetLeagueEntriesByPUUID(PlatformRoute, String, Nullable<CancellationToken>)

Get league entries in all queues for a given puuid Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getLeagueEntriesByPUUID

Declaration
public LeagueEntry[] GetLeagueEntriesByPUUID(PlatformRoute route, string puuid, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String puuid

(required, in path)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
LeagueEntry[]
| Improve this Doc View Source

GetLeagueEntriesByPUUIDAsync(PlatformRoute, String, Nullable<CancellationToken>)

Get league entries in all queues for a given puuid Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getLeagueEntriesByPUUID

Declaration
public Task<LeagueEntry[]> GetLeagueEntriesByPUUIDAsync(PlatformRoute route, string puuid, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String puuid

(required, in path)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
System.Threading.Tasks.Task<LeagueEntry[]>
| Improve this Doc View Source

GetLeagueEntriesForSummoner(PlatformRoute, String, Nullable<CancellationToken>)

Get league entries for a given summoner ID. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getLeagueEntriesForSummoner

Declaration
public LeagueEntry[] GetLeagueEntriesForSummoner(PlatformRoute route, string summonerId, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String summonerId

(required, in path)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
LeagueEntry[]
| Improve this Doc View Source

GetLeagueEntriesForSummonerAsync(PlatformRoute, String, Nullable<CancellationToken>)

Get league entries for a given summoner ID. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getLeagueEntriesForSummoner

Declaration
public Task<LeagueEntry[]> GetLeagueEntriesForSummonerAsync(PlatformRoute route, string summonerId, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String summonerId

(required, in path)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
System.Threading.Tasks.Task<LeagueEntry[]>
| Improve this Doc View Source

GetMasterLeague(PlatformRoute, String, Nullable<CancellationToken>)

Get the master league. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getMasterLeague

Declaration
public LeagueList GetMasterLeague(PlatformRoute route, string queue = null, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String queue

Defaults to RANKED_TFT. (optional, in query)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
LeagueList
| Improve this Doc View Source

GetMasterLeagueAsync(PlatformRoute, String, Nullable<CancellationToken>)

Get the master league. Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getMasterLeague

Declaration
public Task<LeagueList> GetMasterLeagueAsync(PlatformRoute route, string queue = null, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

System.String queue

Defaults to RANKED_TFT. (optional, in query)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
System.Threading.Tasks.Task<LeagueList>
| Improve this Doc View Source

GetTopRatedLadder(PlatformRoute, Enums.QueueType, Nullable<CancellationToken>)

Get the top rated ladder for given queue Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getTopRatedLadder

Declaration
public TopRatedLadderEntry[] GetTopRatedLadder(PlatformRoute route, Enums.QueueType queue, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

QueueType queue

(required, in path)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
TopRatedLadderEntry[]
| Improve this Doc View Source

GetTopRatedLadderAsync(PlatformRoute, Enums.QueueType, Nullable<CancellationToken>)

Get the top rated ladder for given queue Official API Reference: https://developer.riotgames.com/api-methods/#tft-league-v1/GET_getTopRatedLadder

Declaration
public Task<TopRatedLadderEntry[]> GetTopRatedLadderAsync(PlatformRoute route, Enums.QueueType queue, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
PlatformRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)

QueueType queue

(required, in path)

System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)

Returns
Type Description
System.Threading.Tasks.Task<TopRatedLadderEntry[]>
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX