A client that interacts with the Riot Games API. More...

Inheritance diagram for RiotNet.IRiotClient:

Public Member Functions
Task< List< Champion > >	GetChampionsAsync (bool freeToPlay=false, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets dynamic champion information for all champions. This method uses the Champion API. More...

Task< Champion >	GetChampionByIdAsync (long id, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets dynamic champion information for the specified champion. This method uses the Champion API. More...

Task< ChampionMastery >	GetChampionMasteryAsync (string summonerId, long championId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets information about a summoner's mastery of a champion. This method uses the Champion Mastery API. More...

Task< List< ChampionMastery > >	GetChampionMasteriesAsync (string summonerId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets information about a summoner's mastery of all champions they have played. This method uses the Champion Mastery API. More...

Task< int >	GetChampionMasteryScoreAsync (string summonerId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets a summoner's champion mastery score (the sum of the champion levels of all champions for that summoner). This method uses the Champion Mastery API. More...

Task< LeagueList >	GetLeagueByIdAsync (string leagueId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the full league information for all leagues that the summoners are in, including the leages for the teams they are on. Data is mapped by summoner ID. This method uses the League API. More...

Task< List< LeaguePosition > >	GetLeaguePositionsBySummonerIdAsync (string summonerId, string platformId=null, CancellationToken token=default(CancellationToken))
	Get league positions in all queues for a given summoner ID. This method uses the League API. More...

Task< List< LeagueEntry > >	GetLeagueEntriesBySummonerIdAsync (string summonerId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets league entries in all queues for a given summoner ID. This method uses the League API. More...

Task< List< LeagueEntry > >	GetLeagueEntriesAsync (string rankedQueueType, string tier, string division, long page=1, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets league entries for all summoners in a particular divison. This method uses the League API. More...

Task< LeagueList >	GetChallengerLeagueAsync (string rankedQueueType, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the challenger league. This method uses the League API. More...

Task< LeagueList >	GetGrandmasterLeagueAsync (string rankedQueueType, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the grandmaster league. This method uses the League API. More...

Task< LeagueList >	GetMasterLeagueAsync (string rankedQueueType, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the master league. This method uses the League API. More...

Task< Match >	GetMatchAsync (long matchId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the details of a match. This method uses the Match API. More...

Task< MatchTimeline >	GetMatchTimelineAsync (long matchId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the timeline of a match. This method uses the Match API. More...

Task< MatchList >	GetMatchListByAccountIdAsync (string accountId, IEnumerable< long > championIds=null, IEnumerable< QueueType > rankedQueues=null, IEnumerable< Season > seasons=null, DateTime?beginTime=null, DateTime?endTime=null, int?beginIndex=null, int?endIndex=null, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the match list for a summoner. This method uses the Match API. More...

Task< List< long > >	GetMatchIdsByTournamentCodeAsync (string tournamentCode, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the list of match IDs for a tournament code. This method uses the Match API. This endpoint is only accessible if you have a tournament API key. More...

Task< Match >	GetMatchForTournamentAsync (long matchId, string tournamentCode, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the details of a match. This method uses the Match API. This endpoint is only accessible if you have a tournament API key. More...

Task< CurrentGameInfo >	GetActiveGameBySummonerIdAsync (string summonerId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets information about the current game a summoner is playing. This method uses the Spectator API. More...

Task< FeaturedGames >	GetFeaturedGamesAsync (string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the games currently featured in the League of Legends client. This method uses the Spectator API. More...

Task< ShardStatus >	GetShardDataAsync (string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the data for the shard for the specified platform. This method uses the LoL Status API. More...

Task< Summoner >	GetSummonerByAccountIdAsync (string accountId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the summoner information by account ID. This method uses the Summoner API. More...

Task< Summoner >	GetSummonerBySummonerNameAsync (string summonerName, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the summoner information for the specified summoner name. This method uses the Summoner API. More...

Task< Summoner >	GetSummonerBySummonerIdAsync (string summonerId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the summoner information for the specified summoner ID. This method uses the Summoner API. More...

Task< Summoner >	GetSummonerByPuuidAsync (string summonerPuuid, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets the summoner information for the specified summoner ID. This method uses the Summoner API. More...

Task< string >	GetThirdPartyCodeAsync (string summonerId, string platformId=null, CancellationToken token=default(CancellationToken))
	Gets a code that a third-party application can use to verify a summoner. More...

Task< long >	CreateTournamentProviderAsync (string url, string platformId=null, string regionalProxy=RegionalProxy.Americas, CancellationToken token=default(CancellationToken))
	Registers the current client as a tournament provider. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. IMPORTANT: if you are using an interim API key, you must set RiotClientSettings.UseTournamentStub to true before calling this method. More...

Task< long >	CreateTournamentProviderAsync (string url, string platformId, CancellationToken token)
	Registers the current client as a tournament provider. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. IMPORTANT: if you are using an interim API key, you must set RiotClientSettings.UseTournamentStub to true before calling this method. More...

Task< long >	CreateTournamentAsync (long providerId, string name=null, string regionalProxy=RegionalProxy.Americas, CancellationToken token=default(CancellationToken))
	Creates a tournament. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. IMPORTANT: if you are using an interim API key, you must set RiotClientSettings.UseTournamentStub to true before calling this method. More...

Task< long >	CreateTournamentAsync (long providerId, string name, CancellationToken token)
	Creates a tournament. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. IMPORTANT: if you are using an interim API key, you must set RiotClientSettings.UseTournamentStub to true before calling this method. More...

Task< List< string > >	CreateTournamentCodeAsync (long tournamentId, int?count=null, List< string > allowedSummonerIds=null, string mapType=MapType.SUMMONERS_RIFT, string pickType=PickType.TOURNAMENT_DRAFT, string spectatorType=SpectatorType.ALL, int teamSize=5, string metadata=null, string regionalProxy=RegionalProxy.Americas, CancellationToken token=default(CancellationToken))
	Creates one or more tournament codes. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. IMPORTANT: if you are using an interim API key, you must set RiotClientSettings.UseTournamentStub to true before calling this method. More...

Task< List< string > >	CreateTournamentCodeAsync (long tournamentId, int?count, List< string > allowedSummonerIds, string mapType, string pickType, string spectatorType, int teamSize, string metadata, CancellationToken token)
	Creates one or more tournament codes. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. IMPORTANT: if you are using an interim API key, you must set RiotClientSettings.UseTournamentStub to true before calling this method. More...

Task< List< string > >	CreateTournamentCodeAsync (TournamentCode tournamentCode, int?count=null, string regionalProxy=RegionalProxy.Americas, CancellationToken token=default(CancellationToken))
	Saves changes to a tournament code. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. This method does NOT support the tournament stub API. More...

Task< List< string > >	CreateTournamentCodeAsync (TournamentCode tournamentCode, int?count, CancellationToken token)
	Saves changes to a tournament code. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. This method does NOT support the tournament stub API. More...

Task< TournamentCode >	GetTournamentCodeAsync (string tournamentCode, string regionalProxy=RegionalProxy.Americas, CancellationToken token=default(CancellationToken))
	Gets the details of a tournament code. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. This method does NOT support the tournament stub API. More...

Task< TournamentCode >	GetTournamentCodeAsync (string tournamentCode, CancellationToken token)
	Gets the details of a tournament code. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. This method does NOT support the tournament stub API. More...

Task	UpdateTournamentCodeAsync (string tournamentCode, List< string > allowedParticipants=null, string mapType=MapType.SUMMONERS_RIFT, string pickType=PickType.TOURNAMENT_DRAFT, string spectatorType=SpectatorType.ALL, string regionalProxy=RegionalProxy.Americas, CancellationToken token=default(CancellationToken))
	Saves changes to a tournament code. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. This method does NOT support the tournament stub API. More...

Task	UpdateTournamentCodeAsync (string tournamentCode, List< string > allowedParticipants, string mapType, string pickType, string spectatorType, CancellationToken token)
	Saves changes to a tournament code. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. This method does NOT support the tournament stub API. More...

Task	UpdateTournamentCodeAsync (TournamentCode tournamentCode, string regionalProxy=RegionalProxy.Americas, CancellationToken token=default(CancellationToken))
	Saves changes to a tournament code. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. This method does NOT support the tournament stub API. More...

Task	UpdateTournamentCodeAsync (TournamentCode tournamentCode, CancellationToken token)
	Saves changes to a tournament code. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. This method does NOT support the tournament stub API. More...

Task< List< LobbyEvent > >	GetTournamentCodeLobbyEventsAsync (string tournamentCode, string regionalProxy=RegionalProxy.Americas, CancellationToken token=default(CancellationToken))
	Gets the events that happened in the lobby of atournament code game. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. IMPORTANT: if you are using an interim API key, you must set RiotClientSettings.UseTournamentStub to true before calling this method. More...

Task< List< LobbyEvent > >	GetTournamentCodeLobbyEventsAsync (string tournamentCode, CancellationToken token)
	Gets the events that happened in the lobby of atournament code game. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. IMPORTANT: if you are using an interim API key, you must set RiotClientSettings.UseTournamentStub to true before calling this method. More...

Properties
string	PlatformId `[get]`
	Gets the platform ID of the default server to connect to. This should equal one of the Models.PlatformId values. More...

RiotClientSettings	Settings `[get]`
	Gets the settings for the current IRiotClient. More...

Events
RetryEventHandler	RequestTimedOut
	Occurs when the a request times out. More...

RetryEventHandler	ConnectionFailed
	Occurs when the client fails to connect to the server while executing a request. More...

RetryEventHandler	RateLimitExceeded
	Occurs when the client executes a request when the API rate limit has been exceeded. More...

RetryEventHandler	ServerError
	Occurs when the server returns an error code of 500 or higher. More...

ResponseEventHandler	ResourceNotFound
	Occurs when a request fails because a resource was not found. More...

ResponseEventHandler	ResponseError
	Occurs when a response returns an error code that does not fit into any other category, or an exception occurs during the response. More...

Detailed Description

A client that interacts with the Riot Games API.

Member Function Documentation

Task<long> RiotNet.IRiotClient.CreateTournamentAsync	(	long	providerId,
		string	name = `null`,
		string	regionalProxy = `RegionalProxy.Americas`,
		CancellationToken	token = `default(CancellationToken)`
	)

Creates a tournament. This method uses the Tournament API. This endpoint is only accessible if you have a tournament API key. IMPORTANT: if you are using an interim API key, you must set RiotClientSettings.UseTournamentStub to true before calling this method.

Parameters

providerId	The providerID obtained from CreateTournamentProviderAsync.
name	The optional name of the tournament.
regionalProxy	The name of the regional proxy service. This should equal one of the RegionalProxy values.
token	The cancellation token to cancel the operation.

Returns: A task representing the asynchronous operation.

Task<List<string> > RiotNet.IRiotClient.CreateTournamentCodeAsync	(	long	tournamentId,
		int?	count = `null`,
		List< string >	allowedSummonerIds = `null`,
		string	mapType = `MapType.SUMMONERS_RIFT`,
		string	pickType = `PickType.TOURNAMENT_DRAFT`,
		string	spectatorType = `SpectatorType.ALL`,
		int	teamSize = `5`,
		string	metadata = `null`,
		string	regionalProxy = `RegionalProxy.Americas`,
		CancellationToken	token = `default(CancellationToken)`
	)

tournamentId	The tournament ID obtained from CreateTournamentAsync.
count	The number of codes to create (max 1000).
allowedSummonerIds	Optional list of participants in order to validate the players eligible to join the lobby.
mapType	The map type of the game. This should equal one of the MapType values. Note that MapType.CRYSTAL_SCAR is not allowed.
pickType	The pick type of the game. This should equal one of the PickType values.
spectatorType	The spectator type of the game. This should equal one of the SpectatorType values.
teamSize	The team size of the game. Valid values are 1-5.
metadata	Optional string that may contain any data in any format, if specified at all. Used to denote any custom information about the game.
regionalProxy	The name of the regional proxy service. This should equal one of the RegionalProxy values.
token	The cancellation token to cancel the operation.

Task<List<string> > RiotNet.IRiotClient.CreateTournamentCodeAsync	(	TournamentCode	tournamentCode,
		int?	count = `null`,
		string	regionalProxy = `RegionalProxy.Americas`,
		CancellationToken	token = `default(CancellationToken)`
	)

tournamentCode	The definition for the tournament code(s) to create.
count	The number of codes to create (max 1000).
regionalProxy	The name of the regional proxy service. This should equal one of the RegionalProxy values.
token	The cancellation token to cancel the operation.

Task<long> RiotNet.IRiotClient.CreateTournamentProviderAsync	(	string	url,
		string	platformId = `null`,
		string	regionalProxy = `RegionalProxy.Americas`,
		CancellationToken	token = `default(CancellationToken)`
	)

url	The provider's callback URL to which tournament game results in this region should be posted. The URL must be well-formed, use the http or https protocol, and use the default port for the protocol (http URLs must use port 80, https URLs must use port 443).
platformId	The platform ID of the region in which the provider will be running tournaments. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
regionalProxy	The name of the regional proxy service. This should equal one of the RegionalProxy values.
token	The cancellation token to cancel the operation.

Task<CurrentGameInfo> RiotNet.IRiotClient.GetActiveGameBySummonerIdAsync	(	string	summonerId,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

summonerId	The summoner ID.
platformId	The platform ID of the server to connect to. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
token	The cancellation token to cancel the operation.

Task<LeagueList> RiotNet.IRiotClient.GetChallengerLeagueAsync	(	string	rankedQueueType,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

rankedQueueType	The queue type. This should equal one of the RankedQueue values.
platformId	The platform ID of the server to connect to. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
token	The cancellation token to cancel the operation.

Task<Champion> RiotNet.IRiotClient.GetChampionByIdAsync	(	long	id,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

id	The champion id.
platformId	The platform ID of the server to connect to. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
token	The cancellation token to cancel the operation.

Task<List<ChampionMastery> > RiotNet.IRiotClient.GetChampionMasteriesAsync	(	string	summonerId,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

Task<ChampionMastery> RiotNet.IRiotClient.GetChampionMasteryAsync	(	string	summonerId,
		long	championId,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

summonerId	The summoner ID.
championId	The champion ID.
platformId	The platform ID of the server to connect to. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
token	The cancellation token to cancel the operation.

Task<int> RiotNet.IRiotClient.GetChampionMasteryScoreAsync	(	string	summonerId,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

Task<List<Champion> > RiotNet.IRiotClient.GetChampionsAsync	(	bool	freeToPlay = `false`,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

freeToPlay	True to request only free-to-play champion information. Default is false.
platformId	The platform ID of the server to connect to. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
token	The cancellation token to cancel the operation.

Task<FeaturedGames> RiotNet.IRiotClient.GetFeaturedGamesAsync	(	string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

Task<LeagueList> RiotNet.IRiotClient.GetLeagueByIdAsync	(	string	leagueId,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

Property Documentation

Event Documentation

leagueId	The UIID of the league.
platformId	The platform ID of the server to connect to. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
token	The cancellation token to cancel the operation.

Task<List<LeagueEntry> > RiotNet.IRiotClient.GetLeagueEntriesAsync	(	string	rankedQueueType,
		string	tier,
		string	division,
		long	page = `1`,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

rankedQueueType	The queue to search. This should equal one of the RankedQueue values.
tier	The ranked tier. This should equal one of the Tier values. NOTE: must be diamond league or lower. Master+ is not supported.
division	The ranked division. This should equal one of the Division values.
page	The page number to retrieve. The default value is 1 (the first page).
platformId	The platform ID of the server to connect to. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
token	The cancellation token to cancel the operation.

Task<List<LeaguePosition> > RiotNet.IRiotClient.GetLeaguePositionsBySummonerIdAsync	(	string	summonerId,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

Task<Match> RiotNet.IRiotClient.GetMatchAsync	(	long	matchId,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

matchId	The ID of the match.
platformId	The platform ID of the server to connect to. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
token	The cancellation token to cancel the operation.

Task<List<long> > RiotNet.IRiotClient.GetMatchIdsByTournamentCodeAsync	(	string	tournamentCode,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

tournamentCode	The tournament code.
platformId	The platform ID of the server to connect to. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
token	The cancellation token to cancel the operation.

Task<MatchList> RiotNet.IRiotClient.GetMatchListByAccountIdAsync	(	string	accountId,
		IEnumerable< long >	championIds = `null`,
		IEnumerable< QueueType >	rankedQueues = `null`,
		IEnumerable< Season >	seasons = `null`,
		DateTime?	beginTime = `null`,
		DateTime?	endTime = `null`,
		int?	beginIndex = `null`,
		int?	endIndex = `null`,
		string	platformId = `null`,
		CancellationToken	token = `default(CancellationToken)`
	)

accountId	The summoner's account ID.
championIds	Only get games where the summoner played one of these champions.
rankedQueues	Only get games from these queues. You should only use ranked queues for this (QueueType.TEAM_BUILDER_RANKED_SOLO, QueueType.RANKED_FLEX_SR, QueueType.RANKED_FLEX_TT).
seasons	Only get games from these seasons.
beginTime	Only get games played after this time.
endTime	Only get games played before this time.
beginIndex	The begin index to use for fetching games.
endIndex	The end index to use for fetching games. The maximum allowed difference between beginIndex and endIndex is 20; if it is larger than 20, endIndex will be modified to satisfy this restriction.
platformId	The platform ID of the server to connect to. This should equal one of the Models.PlatformId values. If unspecified, the PlatformId property will be used.
token	The cancellation token to cancel the operation.