Class LeagueV4Endpoints

LeagueV4 endpoints. This class is automatically generated.

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

Inheritance

System.Object

Endpoints

LeagueV4Endpoints

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 LeagueV4Endpoints : Endpoints

Methods

| Improve this Doc View Source

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

Get the challenger league for given queue. Official API Reference: https://developer.riotgames.com/api-methods/#league-v4/GET_getChallengerLeague

Declaration

public LeagueList GetChallengerLeague(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
LeagueList

| Improve this Doc View Source

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

Get the challenger league for given queue. Official API Reference: https://developer.riotgames.com/api-methods/#league-v4/GET_getChallengerLeague

Declaration

public Task<LeagueList> GetChallengerLeagueAsync(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<LeagueList>

| Improve this Doc View Source

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

Get the grandmaster league of a specific queue. Official API Reference: https://developer.riotgames.com/api-methods/#league-v4/GET_getGrandmasterLeague

Declaration

public LeagueList GetGrandmasterLeague(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
LeagueList

| Improve this Doc View Source

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

Get the grandmaster league of a specific queue. Official API Reference: https://developer.riotgames.com/api-methods/#league-v4/GET_getGrandmasterLeague

Declaration

public Task<LeagueList> GetGrandmasterLeagueAsync(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<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/#league-v4/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/#league-v4/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.QueueType, Enums.Tier, Enums.Division, Nullable<Int32>, Nullable<CancellationToken>)

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

Declaration

public LeagueEntry[] GetLeagueEntries(PlatformRoute route, Enums.QueueType queue, Enums.Tier tier, Enums.Division division, int? page = 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)
QueueType	queue	Note that the queue value must be a valid ranked queue. (required, in path)
Tier	tier	(required, in path)
Division	division	(required, in path)
System.Nullable<System.Int32>	page	Defaults to 1. Starts with page 1. (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.QueueType, Enums.Tier, Enums.Division, Nullable<Int32>, Nullable<CancellationToken>)

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

Declaration

public Task<LeagueEntry[]> GetLeagueEntriesAsync(PlatformRoute route, Enums.QueueType queue, Enums.Tier tier, Enums.Division division, int? page = 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)
QueueType	queue	Note that the queue value must be a valid ranked queue. (required, in path)
Tier	tier	(required, in path)
Division	division	(required, in path)
System.Nullable<System.Int32>	page	Defaults to 1. Starts with page 1. (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/#league-v4/GET_getLeagueEntriesByPUUID

Declaration

public LeagueEntry[] GetLeagueEntriesByPUUID(PlatformRoute route, string encryptedPUUID, 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	encryptedPUUID	(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/#league-v4/GET_getLeagueEntriesByPUUID

Declaration

public Task<LeagueEntry[]> GetLeagueEntriesByPUUIDAsync(PlatformRoute route, string encryptedPUUID, 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	encryptedPUUID	(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 in all queues for a given summoner ID. Official API Reference: https://developer.riotgames.com/api-methods/#league-v4/GET_getLeagueEntriesForSummoner

Declaration

public LeagueEntry[] GetLeagueEntriesForSummoner(PlatformRoute route, string encryptedSummonerId, 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	encryptedSummonerId	(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 in all queues for a given summoner ID. Official API Reference: https://developer.riotgames.com/api-methods/#league-v4/GET_getLeagueEntriesForSummoner

Declaration

public Task<LeagueEntry[]> GetLeagueEntriesForSummonerAsync(PlatformRoute route, string encryptedSummonerId, 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	encryptedSummonerId	(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, Enums.QueueType, Nullable<CancellationToken>)

Get the master league for given queue. Official API Reference: https://developer.riotgames.com/api-methods/#league-v4/GET_getMasterLeague

Declaration

public LeagueList GetMasterLeague(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
LeagueList

| Improve this Doc View Source

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

Get the master league for given queue. Official API Reference: https://developer.riotgames.com/api-methods/#league-v4/GET_getMasterLeague

Declaration

public Task<LeagueList> GetMasterLeagueAsync(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<LeagueList>