org.dc.riot.lol.rx.service

Interface RiotApi.ChampionMastery

All Superinterfaces:

RiotApi

Enclosing interface:

RiotApi

public static interface RiotApi.ChampionMastery
extends RiotApi

Champion mastery API to fetch player's champion mastery.

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.dc.riot.lol.rx.service.RiotApi

RiotApi.Champion, RiotApi.ChampionMastery, RiotApi.CurrentGame, RiotApi.FeaturedGames, RiotApi.League, RiotApi.LolStatus, RiotApi.Match, RiotApi.MatchList, RiotApi.RateType, RiotApi.RecentGames, RiotApi.StaticData, RiotApi.Stats, RiotApi.Summoner, RiotApi.Team

Method Summary

Modifier and Type	Method and Description
int	getMasteryScore(long summonerId) /championmastery/location/{platformId}/player/{summonerId}/score 404 Not found 500 Something bad happened
ChampionMasteryDto[]	getPlayerAllMastery(long summonerId) /championmastery/location/{platformId}/player/{summonerId}/champions 404 Not found 500 Something bad happened
ChampionMasteryDto	getPlayerChampionMastery(long summonerId, long championId) /championmastery/location/{platformId}/player/{summonerId}/champion/{championId} 404 Not found 500 Something bad happened
static Region[]	getSupportedRegions(float version)
ChampionMasteryDto[]	getTopChampions(long summonerId, int count) /championmastery/location/{platformId}/player/{summonerId}/topchampions 404 Not found 500 Something bad happened

Methods inherited from interface org.dc.riot.lol.rx.service.RiotApi

getApiKey, getRateType, getRegion, getVersion, setAutoRetry, setPrintUrl, setProxy, setRateControl, setRetryCount

Method Detail

getSupportedRegions

static Region[] getSupportedRegions(float version)

Parameters:

version - a positive value denoting the version (e.g. 1.0);

Returns:

the set of Regions this API supports

Throws:

InvalidVersionException - if the version number cannot be mapped to a valid version

getPlayerChampionMastery

ChampionMasteryDto getPlayerChampionMastery(long summonerId,
                                            long championId)
                                     throws java.io.IOException,
                                            HttpException

/championmastery/location/{platformId}/player/{summonerId}/champion/{championId}

404 Not found
500 Something bad happened

Parameters:

summonerId - summoner ID associated with the player

championId - champion ID to retrieve champion mastery for

Returns:

ChampionMasteryDto mapping player to champion mastery

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)

getPlayerAllMastery

ChampionMasteryDto[] getPlayerAllMastery(long summonerId)
                                  throws java.io.IOException,
                                         HttpException

/championmastery/location/{platformId}/player/{summonerId}/champions

404 Not found
500 Something bad happened

Parameters:

summonerId - summoner ID associated with the player

Returns:

array of ChampionMasteryDto mapping player to champion mastery

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)

getMasteryScore

int getMasteryScore(long summonerId)
             throws java.io.IOException,
                    HttpException

/championmastery/location/{platformId}/player/{summonerId}/score

404 Not found
500 Something bad happened

Parameters:

summonerId - summoner ID associated with the player

Returns:

total mastery score for the given player

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)

getTopChampions

ChampionMasteryDto[] getTopChampions(long summonerId,
                                     int count)
                              throws java.io.IOException,
                                     HttpException

/championmastery/location/{platformId}/player/{summonerId}/topchampions

404 Not found
500 Something bad happened

Parameters:

summonerId - summonerId associated with the player

count - best N champions

Returns:

array of ChampionMasteryDto mapping player to champion mastery

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)