Class LolChallengesV1Endpoints

LolChallengesV1 endpoints. This class is automatically generated.

Official API Reference https://developer.riotgames.com/api-methods/#lol-challenges-v1

Inheritance
System.Object
Endpoints
LolChallengesV1Endpoints
Inherited Members
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 LolChallengesV1Endpoints : Endpoints

Methods

| Improve this Doc View Source

GetAllChallengeConfigs(PlatformRoute, Nullable<CancellationToken>)

List of all basic challenge configuration information (includes all translations for names and descriptions) Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getAllChallengeConfigs

Declaration
public ChallengeConfigInfo[] GetAllChallengeConfigs(PlatformRoute route, 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.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
ChallengeConfigInfo[]
| Improve this Doc View Source

GetAllChallengeConfigsAsync(PlatformRoute, Nullable<CancellationToken>)

List of all basic challenge configuration information (includes all translations for names and descriptions) Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getAllChallengeConfigs

Declaration
public Task<ChallengeConfigInfo[]> GetAllChallengeConfigsAsync(PlatformRoute route, 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.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Threading.Tasks.Task<ChallengeConfigInfo[]>
| Improve this Doc View Source

GetAllChallengePercentiles(PlatformRoute, Nullable<CancellationToken>)

Map of level to percentile of players who have achieved it - keys: ChallengeId -> Season -> Level -> percentile of players who achieved it Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getAllChallengePercentiles

Declaration
public IDictionary<long, IDictionary<Enums.Tier, double>> GetAllChallengePercentiles(PlatformRoute route, 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.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Collections.Generic.IDictionary<System.Int64, System.Collections.Generic.IDictionary<Enums.Tier, System.Double>>
| Improve this Doc View Source

GetAllChallengePercentilesAsync(PlatformRoute, Nullable<CancellationToken>)

Map of level to percentile of players who have achieved it - keys: ChallengeId -> Season -> Level -> percentile of players who achieved it Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getAllChallengePercentiles

Declaration
public Task<IDictionary<long, IDictionary<Enums.Tier, double>>> GetAllChallengePercentilesAsync(PlatformRoute route, 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.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IDictionary<System.Int64, System.Collections.Generic.IDictionary<Enums.Tier, System.Double>>>
| Improve this Doc View Source

GetChallengeConfigs(PlatformRoute, Int64, Nullable<CancellationToken>)

Get challenge configuration (REST) Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getChallengeConfigs

Declaration
public ChallengeConfigInfo GetChallengeConfigs(PlatformRoute route, long challengeId, 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.Int64 challengeId

(required, in path)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
ChallengeConfigInfo
| Improve this Doc View Source

GetChallengeConfigsAsync(PlatformRoute, Int64, Nullable<CancellationToken>)

Get challenge configuration (REST) Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getChallengeConfigs

Declaration
public Task<ChallengeConfigInfo> GetChallengeConfigsAsync(PlatformRoute route, long challengeId, 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.Int64 challengeId

(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<ChallengeConfigInfo>
| Improve this Doc View Source

GetChallengeLeaderboards(PlatformRoute, Int64, Enums.Tier, Nullable<Int32>, Nullable<CancellationToken>)

Return top players for each level. Level must be MASTER, GRANDMASTER or CHALLENGER. Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getChallengeLeaderboards

Declaration
public ApexPlayerInfo[] GetChallengeLeaderboards(PlatformRoute route, long challengeId, Enums.Tier level, int? limit = 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.Int64 challengeId

(required, in path)
Tier level

(required, in path)
System.Nullable<System.Int32> limit

(optional, in query)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
ApexPlayerInfo[]
| Improve this Doc View Source

GetChallengeLeaderboardsAsync(PlatformRoute, Int64, Enums.Tier, Nullable<Int32>, Nullable<CancellationToken>)

Return top players for each level. Level must be MASTER, GRANDMASTER or CHALLENGER. Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getChallengeLeaderboards

Declaration
public Task<ApexPlayerInfo[]> GetChallengeLeaderboardsAsync(PlatformRoute route, long challengeId, Enums.Tier level, int? limit = 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.Int64 challengeId

(required, in path)
Tier level

(required, in path)
System.Nullable<System.Int32> limit

(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<ApexPlayerInfo[]>
| Improve this Doc View Source

GetChallengePercentiles(PlatformRoute, Int64, Nullable<CancellationToken>)

Map of level to percentile of players who have achieved it Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getChallengePercentiles

Declaration
public IDictionary<Enums.Tier, double> GetChallengePercentiles(PlatformRoute route, long challengeId, 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.Int64 challengeId

(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.Collections.Generic.IDictionary<Enums.Tier, System.Double>
| Improve this Doc View Source

GetChallengePercentilesAsync(PlatformRoute, Int64, Nullable<CancellationToken>)

Map of level to percentile of players who have achieved it Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getChallengePercentiles

Declaration
public Task<IDictionary<Enums.Tier, double>> GetChallengePercentilesAsync(PlatformRoute route, long challengeId, 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.Int64 challengeId

(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<System.Collections.Generic.IDictionary<Enums.Tier, System.Double>>
| Improve this Doc View Source

GetPlayerData(PlatformRoute, String, Nullable<CancellationToken>)

Returns player information with list of all progressed challenges (REST) Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getPlayerData

Declaration
public PlayerInfo GetPlayerData(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
PlayerInfo
| Improve this Doc View Source

GetPlayerDataAsync(PlatformRoute, String, Nullable<CancellationToken>)

Returns player information with list of all progressed challenges (REST) Official API Reference: https://developer.riotgames.com/api-methods/#lol-challenges-v1/GET_getPlayerData

Declaration
public Task<PlayerInfo> GetPlayerDataAsync(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<PlayerInfo>